Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Возвращает различные характеристики файла заполнителя или папки. Если файл не является заполнителем облачных файлов, API завершится ошибкой. При успешном выполнении информация возвращается в соответствии с конкретным запрошенным InfoClass .
Синтаксис
HRESULT CfGetPlaceholderInfo(
[in] HANDLE FileHandle,
[in] CF_PLACEHOLDER_INFO_CLASS InfoClass,
[out] PVOID InfoBuffer,
[in] DWORD InfoBufferLength,
[out, optional] PDWORD ReturnedLength
);
Параметры
[in] FileHandle
Дескриптор заполнителя, данные которого будут запрашиваться. В отличие от большинства API облачных файлов, которые принимают дескриптор файла, этот интерфейс не изменяет файл каким-либо образом. Поэтому дескриптору файла требуется доступ только READ_ATTRIBUTES .
[in] InfoClass
Сведения о заполнителях. Для этого параметра можно задать значение CF_PLACEHOLDER_STANDARD_INFO или CF_PLACEHOLDER_BASIC_INFO.
[out] InfoBuffer
Указатель на буфер, который будет получать сведения о заполнитель.
[in] InfoBufferLength
Длина InfoBuffer в байтах. Если буфер недостаточно велик, чтобы вместить всю запрошенную информацию, API вернет столько данных, сколько может поместиться в буфер, и вызов завершится сбоем с HRESULT_FROM_WIN32(ERROR_MORE_DATA).
[out, optional] ReturnedLength
Число байтов, возвращенных в InfoBuffer.
Возвращаемое значение
Если эта функция выполняется успешно, она возвращает .S_OK В противном случае возвращается код ошибки HRESULT .
Комментарии
Сведения о заполнителях включают следующие атрибуты:
| attribute | Описание |
|---|---|
| OnDiskDataSize | Общее число байтов на диске. |
| ValidatedDataSize | Общее количество байтов, синхронизированных с облаком. |
| ModifiedDataSize | Общее количество байтов, которые были перезаписаны или добавлены локально, т. е. не синхронизированы с облаком. |
| СвойстваSize | Общее количество байтов на диске, используемых всеми blob-объектами свойства. |
| PinState | Дополнительные сведения см. в разделе CfSetPinState . |
| InSyncState | Дополнительные сведения см. в разделе CfSetInSyncState . |
| FileId | 64-разрядное непостоящее число тома, которое однозначно идентифицирует файл или каталог. |
| SyncRootFileId | Идентификатор корневого каталога синхронизации, в котором находится файл, в котором запрашиваются сведения о заполнителях. |
| FileIdentity | Непрозрачный BLOB-объект, предоставленный поставщиком синхронизации платформе при создании заполнителя. Удостоверение файла предоставляется для всех обратных вызовов поставщика синхронизации. |
| FileIdentityLength | Длина удостоверения файла в байтах. |
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows 10, версия 1709 [только классические приложения] |
| Минимальная версия сервера | Windows Server 2016 [только классические приложения] |
| Целевая платформа | Windows |
| Header | cfapi.h |
| Библиотека | CldApi.lib |
| DLL | CldApi.dll |