CfExecute function (cfapi.h)

The main entry point for all connection key based placeholder operations. It is intended to be used by a sync provider to respond to various callbacks from the platform.

Syntax

HRESULT CfExecute(
  [in]      const CF_OPERATION_INFO *OpInfo,
  [in, out] CF_OPERATION_PARAMETERS *OpParams
);

Parameters

[in] OpInfo

Information about an operation on a placeholder.

[in, out] OpParams

Parameters of an operation on a placeholder.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

A valid call to CfExecute will reset the timers of all pending callback requests that belong to the same sync provider process.

CfExecute takes two variable-sized arguments, i.e., CF_OPERATION_INFO and CF_OPERATION_PARAMETERS, with one identifying the operation type and the other supplying detailed operation parameters. Both arguments start with a StructSize field at the beginning of the corresponding structures. Callers of CfExecute are responsible for accurate accounting of the structure size.

Requirements

   
Minimum supported client Windows 10, version 1709 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header cfapi.h
Library CldApi.lib
DLL CldApi.dll