cfReportSyncStatus 函数 (cfapi.h)

  • 项目

允许同步提供程序在指定的同步根上通知平台其状态，而无需先通过调用 CfConnectSyncRoot 进行连接。

语法

HRESULT CfReportSyncStatus(
  [in, out] LPCWSTR        SyncRootPath,
  [in]      CF_SYNC_STATUS *SyncStatus
);

参数

[in, out] SyncRootPath

同步根目录的路径。

[in] SyncStatus

要报告的同步状态;如果 NULL为 ，则清除以前保存的同步状态。 有关详细信息，请参阅下面的 “备注 ”部分。

返回值

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

注解

如果 SyncStatus 参数中提供了非 null CF_SYNC_STATUS，则会在同步根上记住该信息，直到同步提供程序显式清除该信息或计算机重新启动为止。 平台将使用以下过程在云文件占位符上执行任何失败的操作时查询此信息：

  1. 平台将首先在文件级别搜索同步状态。
  2. 如果未找到同步状态，平台将搜索在同步根级别注册的同步状态，这是通过此函数完成的。
  3. 找到同步状态后，平台将使用提供的信息来向用户构造更有意义和可操作的消息。

使用同步状态调用时，CfReportSyncStatus 会清除以前保存的NULL同步状态。 如果函数调用失败，将不会对现有同步状态进行更改。

要求

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

另请参阅

CfConnectSyncRoot

CF_SYNC_STATUS