CfGetPlaceholderInfo 関数 (cfapi.h)
プレースホルダー ファイルまたはフォルダーのさまざまな特性を取得します。 ファイルがクラウド ファイル プレースホルダーでない場合、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 エラー コードを返します。
注釈
プレースホルダー情報には、次の属性が含まれます。
| 属性 | 説明 |
|---|---|
| OnDiskDataSize | ディスク上の合計バイト数。 |
| ValidatedDataSize | クラウドと同期している合計バイト数。 |
| ModifiedDataSize | ローカルで上書きまたは追加されたバイトの合計数。つまり、クラウドと同期していません。 |
| PropertiesSize | すべてのプロパティ BLOB で使用されるディスク上の合計バイト数。 |
| PinState | 詳細については、 CfSetPinState を参照してください。 |
| InSyncState | 詳細については、 CfSetInSyncState を参照してください。 |
| FileId | ファイルまたはディレクトリを一意に識別する 64 ビット ボリューム全体の不揮発性番号。 |
| SyncRootFileId | プレースホルダー情報を照会するファイルが存在する同期ルート ディレクトリのファイル ID。 |
| FileIdentity | プレースホルダーの作成時に同期プロバイダーによってプラットフォームに提供される不透明な BLOB。 ファイル ID は、すべての同期プロバイダー コールバックに対して提供されます。 |
| FileIdentityLength | ファイル ID の長さ (バイト単位)。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 10バージョン 1709 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2016 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | cfapi.h |
| Library | CldApi.lib |
| [DLL] | CldApi.dll |