GetUpdateRect 関数 (winuser.h)

GetUpdateRect 関数は、指定したウィンドウの更新領域を完全に囲む最小の四角形の座標を取得します。 GetUpdateRect は、論理座標で四角形を取得します。 更新領域がない場合、 GetUpdateRect は空の四角形を取得します (すべての座標を 0 に設定します)。

構文

BOOL GetUpdateRect(
  [in]  HWND   hWnd,
  [out] LPRECT lpRect,
  [in]  BOOL   bErase
);

パラメーター

[in] hWnd

更新領域を取得するウィンドウを処理します。

[out] lpRect

外側の四角形の座標をデバイス単位で受け取る RECT 構造体へのポインター。

アプリケーションでは、このパラメーターを NULL に設定して、ウィンドウの更新領域が存在するかどうかを判断できます。 このパラメーターが NULL の場合、 GetUpdateRect は更新領域が存在する場合は 0 以外を返し、存在しない場合は 0 を返します。 これにより、 WM_PAINT メッセージが無効な領域から生じるかどうかを判断するための簡単で効率的な手段が提供されます。

[in] bErase

更新領域の背景を消去するかどうかを指定します。 このパラメーターが TRUE で 、更新領域が空でない場合、 GetUpdateRect は、指定したウィンドウに WM_ERASEBKGND メッセージを送信して背景を消去します。

戻り値

更新領域が空でない場合、戻り値は 0 以外です。

更新領域がない場合、戻り値は 0 です。

解説

BeginPaint 関数によって取得される更新四角形は、GetUpdateRect によって取得された四角形と同じです。

BeginPaint は更新リージョンを自動的に検証するため、BeginPaint の呼び出しの直後に行われた GetUpdateRect の呼び出しで空の更新領域が取得されます。

要件

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

関連項目

BeginPaint

GetUpdateRgn

InvalidateRect

描画関数と描画関数

描画と描画の概要

Rect

UpdateWindow

ValidateRect