CF_SYNC_REGISTRATION 结构 (cfapi.h)

  • 项目

要注册的同步提供程序和同步根的详细信息。

语法

typedef struct CF_SYNC_REGISTRATION {
  ULONG   StructSize;
  LPCWSTR ProviderName;
  LPCWSTR ProviderVersion;
  LPCVOID SyncRootIdentity;
  DWORD   SyncRootIdentityLength;
  LPCVOID FileIdentity;
  DWORD   FileIdentityLength;
  GUID    ProviderId;
} CF_SYNC_REGISTRATION;

成员

StructSize

CF_SYNC_REGISTRATION结构的大小。

ProviderName

同步提供程序的名称。 这是一个用户友好的字符串，最大长度为 255 个字符。

ProviderVersion

同步提供程序的版本。 这是一个用户友好的字符串，最大长度为 255 个字符。

SyncRootIdentity

提供程序使用的同步根标识。 此成员是可选的，最大大小为 64 KB。 超过最大长度时，API 会失败 并ERROR_INVALID_PARAMETER 。 平台将在同步提供程序的任何回调中向同步提供程序提供 SyncRootIdentity 。

SyncRootIdentityLength

SyncRootIdentity 的长度。 此成员是可选的，仅在提供 SyncRootIdentity 时才使用。

FileIdentity

可选的文件标识。 此成员的最大大小为 4 KB。 超过最大长度时，API 会失败 并ERROR_INVALID_PARAMETER 。 仅当回调的主题是同步根本身时，才会提供同步根 FileIdentity Blob。

FileIdentityLength

FileIdentity 的长度。 此成员是可选的，仅在提供 FileIdentity 时才使用。

ProviderId

这是用于标识特定同步提供程序的 GUID。 它是可选的。 如果未提供，平台将使用 ProviderName 字符串的 MD5 哈希生成 GUID。 此信息仅用于遥测，以便平台可以更有效地、更准确地关联来自同一同步提供程序的活动，即使同步提供程序使用不同的 ProviderName 字符串注册同步根。 建议同步提供程序始终为其同步产品的所有版本提供相同的 GUID () 。 另一方面，同步提供程序可以自由选择不同的 ProviderName 字符串，以便获得最佳用户体验。

注解

SyncRootIdentity 和 SyncRootIdentityLength 是可选成员。 如果未使用，请将 SyncRootIdentity 设置为 nullptr ， 将 SyncRootIdentityLength 设置为 0。 FileIdentity 和 FileIdentityLength 也是可选的，如果未使用，应分别设置为 nullptr 和 0。

要求

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

另请参阅

CfRegisterSyncRoot