CfGetPlaceholderRangeInfo 関数 (cfapi.h)
プレースホルダー ファイルまたはフォルダーに関する範囲情報を取得します。
構文
HRESULT CfGetPlaceholderRangeInfo(
[in] HANDLE FileHandle,
[in] CF_PLACEHOLDER_RANGE_INFO_CLASS InfoClass,
[in] LARGE_INTEGER StartingOffset,
[in] LARGE_INTEGER Length,
[out] PVOID InfoBuffer,
[in] DWORD InfoBufferLength,
[out, optional] PDWORD ReturnedLength
);
パラメーター
[in] FileHandle
クエリを実行するプレースホルダー ファイルのハンドル。
[in] InfoClass
プレースホルダー データの範囲の型。
[in] StartingOffset
データ範囲の開始点のオフセット。
[in] Length
データ範囲の長さ。 プロバイダーは、情報が要求される範囲が StartingOffset からファイルの末尾であることを示すために、Length にを指定CF_EOFできます。
[out] InfoBuffer
データを受信するバッファーへのポインター。 バッファーは 、CF_FILE_RANGE 構造体の配列です。これはオフセットと長さのペアであり、要求された範囲を記述します。
[in] InfoBufferLength
InfoBuffer の長さ (バイト単位)。
[out, optional] ReturnedLength
InfoBuffer で返されるプレースホルダー データの範囲の長さ。
戻り値
この関数が成功すると、 が返されます S_OK。 それ以外の場合は、 HRESULT エラー コードが返されます。 一般的なエラー コードを次の表に示します。
| エラー コード | 意味 |
|---|---|
| HRESULT_FROM_WIN32( ERROR_HANDLE_EOF ) | つまり、 StartingOffset>= ファイルの末尾の位置です。 |
| HRESULT_FROM_WIN32( ERROR_MORE_DATA ) | これは、次の CF_FILE_RANGE エントリが指定されたバッファーに収まらないことを意味します。 呼び出し元は、返された InfoBufferWritten 値を使用して、エントリが受信されたかどうかを確認する必要があります。 |
注釈
ファイル ハンドルを受け取るほとんどのプレースホルダー API とは異なり、この API はファイルを変更しないため、ファイル ハンドルにはREAD_ATTRIBUTESアクセスのみが必要です。
要件
| サポートされている最小のクライアント | Windows 10、バージョン 1709 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2016 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | cfapi.h |
| Library | CldApi.lib |
| [DLL] | CldApi.dll |