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 |
| Library | CldApi.lib |
| [DLL] | CldApi.dll |