Функция 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 указано ненулевое CF_SYNC_STATUS, сведения будут запоминаться в корневом каталоге синхронизации до тех пор, пока поставщик синхронизации не очистит их явным образом или при перезагрузке компьютера. Платформа будет запрашивать эти сведения при любых неудачных операциях с заполнителем облачного файла, используя следующий процесс:

1. Сначала платформа выполнит поиск состояния синхронизации на уровне файла.
2. Если состояние синхронизации не найдено, платформа будет искать состояние синхронизации, зарегистрированное на корневом уровне синхронизации, что выполняется с помощью этой функции.
3. После того как состояние синхронизации будет найдено, платформа будет использовать предоставленные сведения для создания более значимого и практического сообщения для пользователя.

CfReportSyncStatus очищает ранее сохраненное состояние синхронизации при вызове с состоянием NULL синхронизации. В случае сбоя вызова функции существующее состояние синхронизации не будет изменено.

Требования

Требование	Значение
Минимальная версия клиента	Windows 10, версия 1803 [только классические приложения]
Минимальная версия сервера	Windows Server 2016 [только классические приложения]
Целевая платформа	Windows
Header	cfapi.h
Библиотека	CldApi.lib
DLL	CldApi.dll

См. также раздел

CfConnectSyncRoot

CF_SYNC_STATUS