структура CF_SYNC_STATUS (cfapi.h)

Используется в структуре 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

Смещение большого двоичного объекта идентификатора устройства относительно начала CF_SYNC_STATUS. Большой двоичный объект идентификатора устройства является необязательным и непрозрачным для платформы. Ожидается, что большой двоичный объект будет уникальным на каждом устройстве. Если это указано, большой двоичный объект будет собираться как часть телеметрии платформы, чтобы помочь диагностировать технические проблемы.

DeviceIdLength

Размер большого двоичного объекта идентификатора устройства в байтах.

Замечания

Если указатель null задан в поле SyncStatus структуры CF_OPERATION_INFO, платформа очистит состояние синхронизации ранее заданного значения, если он есть.

Требования

См. также

CF_OPERATION_INFO