cfUnregisterSyncRoot 函数 (cfapi.h)

  • 项目

取消注册以前注册的同步根目录。

语法

HRESULT CfUnregisterSyncRoot(
  [in] LPCWSTR SyncRootPath
);

参数

[in] SyncRootPath

要注销的同步根路径。

返回值

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

注解

注销已注册到 CfRegisterSyncRoot 的同步根。 这通常在同步提供程序卸载时、删除用户帐户时或当用户选择不再同步目录树 (（如果同步提供程序) 支持）时调用。 如果以前从未注册过要注销的同步根目录，则 API 会失败并 STATUS_CLOUD_FILE_NOT_UNDER_SYNC_ROOT。

同步提供程序应具有 WRITE_DATA 或 WRITE_DAC 要注销的同步根的访问权限，否则取消注册将失败并显示 HRESULT (ERROR_CLOUD_FILE_ACCESS_DENIED) 。 如果同步提供程序连接到同步根目录，则取消注册也会失败，并 (ERROR_CLOUD_FILE_INVALID_REQUEST) HRESULT。

通过遍历同步根目录树来取消注册同步根目录。

对于占位符文件：

  • 如果占位符文件已完全冻结，则会将其还原为“普通”文件。
  • 如果占位符文件未解除冻结，则会从本地计算机中将其永久删除。

对于占位符目录：

  • 如果占位符目录已完全填充，则会将其还原为“普通”目录。
  • 如果未完全填充占位符目录，则会从本地计算机中永久删除该目录。

注意

如果无法还原或删除占位符文件或目录，则会跳过该占位符文件或目录，并且取消注册过程将继续，直到遍历完全同步根树。

要求

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

另请参阅

CfRegisterSyncRoot