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