共用方式為

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，此 API 不會以任何方式修改檔案，因此 FileHandle 只需要 READ_ATTRIBUTES 存取權。

如果檔案不在雲端檔案同步根目錄下，API 將會失敗。 成功時，會根據所要求的特定 InfoClass 傳回資訊。

規格需求

需求 值
最低支援的用戶端 Windows 10 1709 版 [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2016 [僅限傳統型應用程式]
目標平台 Windows
標頭 cfapi.h
程式庫 CldApi.lib
Dll CldApi.dll

另請參閱

CfGetSyncRootInfoByPath