RegisterClipboardFormatA 関数 (winuser.h)

  • [アーティクル]

新しいクリップボード形式を登録します。 この形式は、有効なクリップボード形式として使用できます。

構文

UINT RegisterClipboardFormatA(
  [in] LPCSTR lpszFormat
);

パラメーター

[in] lpszFormat

種類: LPCTSTR

新しい形式の名前。

戻り値

型: UINT

関数が成功した場合、戻り値は登録済みのクリップボード形式を識別します。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

指定した名前の登録済み形式が既に存在する場合、新しい形式は登録されず、戻り値によって既存の形式が識別されます。 これにより、複数のアプリケーションで、同じ登録済みクリップボード形式を使用してデータをコピーして貼り付けることができます。 形式名の比較では大文字と小文字が区別されません。

登録済みのクリップボード形式は、0xFFFF 0xC000範囲内の値によって識別されます。

登録済みのクリップボード形式をクリップボードに配置するか、クリップボードから取得する場合は、 HGLOBAL 値の形式にする必要があります。

例

例については、「 クリップボード形式の登録」を参照してください。

注意

winuser.h ヘッダーは、RegisterClipboardFormat をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

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

関連項目

クリップボード

概念

CountClipboardFormats

EnumClipboardFormats

GetClipboardFormatName

参照