EnumClipboardFormats 関数 (winuser.h)

  • [アーティクル]

クリップボードで現在使用できるデータ形式を列挙します。

クリップボードのデータ形式は、順序付きリストに格納されます。 クリップボードのデータ形式の列挙を実行するには、 EnumClipboardFormats 関数を一連の呼び出しで実行します。 呼び出しごとに、 format パラメーターは使用可能なクリップボード形式を指定し、関数は次に使用可能なクリップボード形式を返します。

構文

UINT EnumClipboardFormats(
  [in] UINT format
);

パラメーター

[in] format

型: UINT

使用可能であることがわかっているクリップボード形式。

クリップボード形式の列挙を開始するには、 書式 を 0 に設定します。 format が 0 の場合、関数は使用可能な最初のクリップボード形式を取得します。 列挙中の後続の呼び出しの場合は、 format を前の EnumClipboardFormats 呼び出しの結果に設定します。

戻り値

型: UINT

関数が成功した場合、戻り値は、指定した形式 (つまり、次に使用可能なクリップボード形式) に従うクリップボード形式です。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。 クリップボードが開かない場合、関数は失敗します。

列挙するクリップボード形式がこれ以上ない場合、戻り値は 0 になります。 この場合、 GetLastError 関数は ERROR_SUCCESS値を返します。 これにより、関数の失敗と列挙の終了を区別できます。

注釈

形式を列挙する前に、クリップボードを開く必要があります。 クリップボードを開くには、 OpenClipboard 関数を使用します。 クリップボードが開かない場合 、EnumClipboardFormats 関数は失敗します。

EnumClipboardFormats 関数は、クリップボードに配置された順序で書式を列挙します。 情報をクリップボードにコピーする場合は、最もわかりやすいクリップボード形式から最もわかりやすいクリップボード形式に順にクリップボード オブジェクトを追加します。 クリップボードから情報を貼り付ける場合は、処理できる最初のクリップボード形式を取得します。 これは、処理できる最もわかりやすいクリップボード形式になります。

システムは、特定のクリップボード形式に対して自動型変換を提供します。 このような形式の場合、この関数は指定した形式を列挙し、変換できる形式を列挙します。 詳細については、「 標準のクリップボード形式 」と「 合成クリップボード形式」を参照してください。

例

例については、「 クリップボード ビューアーの例」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-misc-l1-5-1 (Windows 10 バージョン 10.0.14393 で導入)

関連項目

クリップボード

概念

CountClipboardFormats

OpenClipboard

リファレンス

RegisterClipboardFormat