Функция CfGetSyncRootInfoByPath (cfapi.h)

Получает различные сведения о корнях синхронизации, заданные в корневом каталоге синхронизации.

Синтаксис

HRESULT CfGetSyncRootInfoByPath(
  [in]            LPCWSTR                 FilePath,
  [in]            CF_SYNC_ROOT_INFO_CLASS InfoClass,
  [out]           PVOID                   InfoBuffer,
  [in]            DWORD                   InfoBufferLength,
  [out, optional] DWORD                   *ReturnedLength
);

Параметры

[in] FilePath

Полный путь к файлу, корневой каталог которого требуется запросить.

[in] InfoClass

Типы корневой информации синхронизации.

[out] InfoBuffer

Указатель на буфер, который будет получать сведения о корневом каталоге синхронизации.

[in] InfoBufferLength

Длина InfoBuffer (в байтах).

[out, optional] ReturnedLength

Длина возвращаемых корневых сведений синхронизации (в байтах). Дополнительные сведения о корневом каталоге синхронизации см. в разделе CfRegisterSyncRoot .

Возвращаемое значение

Если эта функция выполняется успешно, она возвращает .S_OK В противном случае возвращается код ошибки HRESULT .

Комментарии

Если файл не находится под корнем синхронизации облачных файлов, API завершится ошибкой. При успешном выполнении информация возвращается в соответствии с конкретным запрошенным InfoClass .

Параметр InfoClass может иметь одно из следующих значений из CF_SYNC_ROOT_INFO_CLASS:

• CF_SYNC_ROOT_INFO_BASIC
• CF_SYNC_ROOT_INFO_STANDARD
• CF_SYNC_ROOT_INFO_PROVIDER

Требования

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

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

CfRegisterSyncRoot

CfGetSyncRootInfoByHandle