BeginPaint 関数 (winuser.h)

[アーティクル]
03/04/2024

BeginPaint 関数は、指定したウィンドウを描画用に準備し、PAINTSTRUCT 構造体に描画に関する情報を入力します。

構文

HDC BeginPaint(
  [in]  HWND          hWnd,
  [out] LPPAINTSTRUCT lpPaint
);

パラメーター

[in] hWnd

再描画するウィンドウへのハンドル。

[out] lpPaint

描画情報を受け取る PAINTSTRUCT 構造体へのポインター。

戻り値

関数が成功した場合、戻り値は、指定されたウィンドウの表示デバイスコンテキストへのハンドルです。

関数が失敗した場合、戻り値は NULL であり、使用できるディスプレイデバイスコンテキストがないことを示します。

注釈

BeginPaint 関数は、更新領域の外部の領域を除外するように、デバイスコンテキストのクリッピング領域を自動的に設定します。更新領域は、InvalidateRect 関数または InvalidateRgn 関数、およびクライアント領域に影響を与えるサイズ変更、移動、作成、スクロール、またはその他の操作の後にシステムによって設定されます。更新リージョンに消去のマークが付けられている場合、 BeginPaint は ウィンドウにWM_ERASEBKGND メッセージを送信します。

アプリケーションは、WM_PAINT メッセージへの応答を除き、BeginPaint を呼び出さないでください。 BeginPaint の各呼び出しには、EndPaint 関数の対応する呼び出しが必要です。

キャレットが塗りつぶされる領域にある場合、 BeginPaint は自動的にキャレットを非表示にして、キャレットが消去されないようにします。

ウィンドウのクラスに背景ブラシがある場合、 BeginPaint は、そのブラシを使用して更新領域の背景を消去してから、を返します。

DPI 仮想化

この API は DPI 仮想化には参加しません。返される出力は、常に物理ピクセルの観点から返されます。

例

例については、「クライアント領域での描画」を参照してください。

要件

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