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 |
標頭 | cfapi.h |
程式庫 | CldApi.lib |
DLL | CldApi.dll |