SetClipboardViewer 関数 (winuser.h)

[アーティクル]
08/28/2023

クリップボードビューアーのチェーンに、指定したウィンドウを追加します。クリップボードビューアーウィンドウでは、クリップボードの内容が変更されるたびに WM_DRAWCLIPBOARD メッセージが表示されます。この関数は、以前のバージョンの Windows との下位互換性のために使用されます。

構文

HWND SetClipboardViewer(
  [in] HWND hWndNewViewer
);

パラメーター

[in] hWndNewViewer

型: HWND

クリップボードチェーンに追加するウィンドウのハンドル。

戻り値

型: HWND

関数が成功した場合、戻り値はクリップボードビューアーチェーン内の次のウィンドウを識別します。エラーが発生した場合、またはクリップボードビューアーチェーンに他のウィンドウがない場合、戻り値は NULL です。詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

クリップボードビューアーウィンドウと呼ばれるクリップボードビューアーチェーンの一部であるウィンドウは、クリップボードメッセージをWM_CHANGECBCHAIN 処理し、 WM_DRAWCLIPBOARDする必要があります。各クリップボードビューアーウィンドウは、SendMessage 関数を呼び出して、これらのメッセージをクリップボードビューアーチェーン内の次のウィンドウに渡します。

クリップボードビューアーウィンドウは、最終的に ChangeClipboardChain 関数 (たとえば、 WM_DESTROY メッセージに応答して) を呼び出すことによって、クリップボードビューアーチェーンから自身を削除する必要があります。

SetClipboardViewer 関数は、以前のバージョンの Windows との下位互換性を提供するために存在します。クリップボードビューアーチェーンは、クリップボードチェーンメッセージを適切に処理できないアプリケーションによって破損する可能性があります。新しいアプリケーションでは、クリップボードのシーケンス番号やクリップボード形式リスナーの登録など、より堅牢な手法を使用する必要があります。これらの代替手法の詳細については、「クリップボードの内容の監視」を参照してください。

例

例については、「クリップボードビューアーチェーンへのウィンドウの追加」を参照してください。

要件

要件	値
サポートされている最小のクライアント	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 で導入)