CfDisconnectSyncRoot 函数 (cfapi.h)

  • 项目

断开 CfConnectSyncRoot 创建的信道的连接。

语法

HRESULT CfDisconnectSyncRoot(
  [in] CF_CONNECTION_KEY ConnectionKey
);

参数

[in] ConnectionKey

从 CfConnectSyncRoot 返回的连接密钥，该密钥现在用于断开同步根的连接。

返回值

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

注解

这会删除与以前使用 CfConnectSyncRoot 建立的平台的通信通道。

同步提供程序仍然可以在 CfDisconnectSyncRoot 调用期间接收回调，并且提供程序可以自由选择调用是需要失败还是需要提供服务。 任一选择都不会对同步提供程序造成中断。

调用 CfDisconnectSyncRoot 返回后，同步提供程序将不再接收回调，并且平台将失败依赖于上述回调的任何操作。

同步提供程序应具有 WRITE_DATA 或 WRITE_DAC 对要断开连接的同步根的访问权限，否则调用 CfDisconnectSyncRoot 将失败，并出现 HRESULT (ERROR_CLOUD_FILE_ACCESS_DENIED) 。 此外，如果之前尚未连接同步根，则调用将失败，参数无效。 可以在正常关闭同步提供程序时调用此 API。 但是，如果同步提供程序进程选择在不调用此 API 的情况下终止，或者意外崩溃，平台将检测到此情况并执行必要的清理。

要求

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

另请参阅

CfConnectSyncRoot