cfapi.h) (CF_SYNC_STATUS 结构

  • 项目

在 CF_OPERATION_INFO 结构中用于描述指定同步根的状态。

语法

typedef struct CF_SYNC_STATUS {
  ULONG StructSize;
  ULONG Code;
  ULONG DescriptionOffset;
  ULONG DescriptionLength;
  ULONG DeviceIdOffset;
  ULONG DeviceIdLength;
} CF_SYNC_STATUS;

成员

StructSize

同步状态结构的大小（以字节为单位），包括实际说明字符串。

Code

此参数的使用完全由支持此丰富同步状态构造的同步提供程序决定。

对于特定的同步提供程序，代码和说明字符串之间应存在 1：1 映射。

建议使用最高位顺序来描述错误代码的类型： 1 对于错误级别代码， 0 对于信息级代码。

注意

代码 对平台不透明，仅用于跟踪目的。

DescriptionOffset

说明字符串相对于 CF_SYNC_STATUS开头的偏移量。 它指向本地化的以 null 结尾的宽字符串，该字符串应包含有关该文件的更有意义和可操作的信息。 同步提供程序应平衡提供更多可操作的信息和维护尽可能小的内存占用的需求。

DescriptionLength

包含 null 终止符的说明字符串的大小（以字节为单位）。

DeviceIdOffset

设备 ID blob 相对于 CF_SYNC_STATUS开始的偏移量。 设备 ID blob 是可选的，对平台不透明。 Blob 在每台设备上应是唯一的。 如果提供，Blob 将作为平台遥测的一部分收集，以帮助诊断技术问题。

DeviceIdLength

设备 ID blob 的大小（以字节为单位）。

注解

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

要求

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

另请参阅

CF_OPERATION_INFO