CfExecute 函数 (cfapi.h)

  • 项目

所有基于连接键的占位符操作的main入口点。 同步提供程序打算使用它来响应来自平台的各种回调。

语法

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

参数

[in] OpInfo

有关占位符上的操作的信息。

[in, out] OpParams

占位符上的操作的参数。

返回值

如果此函数成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。

注解

对 CfExecute 的有效调用将重置属于同一同步提供程序进程的所有挂起回调请求的计时器。

CfExecute 采用两个可变大小的参数，即 CF_OPERATION_INFO 和 CF_OPERATION_PARAMETERS，其中一个用于标识操作类型，另一个提供详细的操作参数。 这两个参数都以相应结构开头的 StructSize 字段开头。 CfExecute 的调用方负责准确计算结构大小。

该平台为注册到 CfConnectSyncRoot 的所有回调函数提供 ConnectionKey、TransferKey 和 CorrelationVector。 此外，同步提供程序可以使用 CfGetTransferKey 获取 TransferKey，使用 CfGetCorrelationVector 获取 CorrelationVector。

（可选）同步提供程序可以向平台提供同步状态 blob。 如果在 CF_OPERATION_INFO 的 SyncStatus 字段中设置了非 null 指针，则其内容将保留在文件中，直到删除该文件上的最后一个句柄。 平台将在云文件占位符上的任何失败操作时查询此信息。 如果可用，平台将使用提供的信息向用户构造更有意义且可操作的消息。

如果在 CF_OPERATION_INFO 的 SyncStatus 字段中设置了 null 指针，则平台将清除以前设置的同步状态 (（如果存在) ）。

可以在同步提供程序进程中的任意线程上下文中执行所有操作。

要求

要求 值
最低受支持的客户端 Windows 10版本 1709 [仅限桌面应用]
最低受支持的服务器 Windows Server 2016 [仅限桌面应用]
目标平台 Windows
标头 cfapi.h
Library CldApi.lib
DLL CldApi.dll

另请参阅

CfConnectSyncRoot

CfGetCorrelationVector

CF_OPERATION_INFO

CF_OPERATION_PARAMETERS