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

Возвращает различные характеристики корня синхронизации, содержащего заданный файл, заданный дескриптором файла.

Синтаксис

HRESULT CfGetSyncRootInfoByHandle(
  [in]            HANDLE                  FileHandle,
  [in]            CF_SYNC_ROOT_INFO_CLASS InfoClass,
  [out]           PVOID                   InfoBuffer,
  [in]            DWORD                   InfoBufferLength,
  [out, optional] DWORD                   *ReturnedLength
);

Параметры

[in] FileHandle

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

[in] InfoClass

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

[out] InfoBuffer

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

[in] InfoBufferLength

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

[out, optional] ReturnedLength

Число байтов, возвращенных в InfoBuffer.

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

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

Комментарии

В отличие от большинства API заполнителей, которые принимают дескриптор файла, этот не изменяет файл каким-либо образом, поэтому FileHandle требует только READ_ATTRIBUTES доступа.

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

Требования

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

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

CfGetSyncRootInfoByPath