InvalidateRect

関数

指定矩形を無効化して再描画対象に追加する。

DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll
#include <windows.h>

BOOL InvalidateRect(
    HWND hWnd,   // optional
    const RECT* lpRect,   // optional
    BOOL bErase
);

パラメーター

名前	型	方向	説明
hWnd	HWND	inoptional	更新領域が変更されたウィンドウへのハンドル。このパラメーターが NULL の場合、システムはこのアプリケーションのウィンドウだけでなくすべてのウィンドウを無効化して再描画し、関数が戻る前に WM_ERASEBKGND メッセージと WM_NCPAINT メッセージを送信します。このパラメーターを NULL に設定することは推奨されません。
lpRect	RECT*	inoptional	更新領域に追加する矩形のクライアント座標を格納した RECT 構造体へのポインター。このパラメーターが NULL の場合、クライアント領域全体が更新領域に追加されます。
bErase	BOOL	in	更新領域が処理される際に、その内部の背景を消去するかどうかを指定します。このパラメーターが TRUE の場合、BeginPaint 関数が呼び出されたときに背景が消去されます。このパラメーターが FALSE の場合、背景は変更されません。

戻り値の型: BOOL

公式ドキュメント

InvalidateRect 関数は、指定したウィンドウの更新領域に矩形を追加します。更新領域は、再描画が必要なウィンドウのクライアント領域の部分を表します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

無効化された領域は、次の WM_PAINT メッセージが発生したときに領域が処理されるか、ValidateRect 関数または ValidateRgn 関数によって領域が有効化されるまで、更新領域に蓄積されます。

システムは、ウィンドウの更新領域が空でなく、かつそのウィンドウに対するほかのメッセージがアプリケーションキューに存在しない場合は常に、そのウィンドウに WM_PAINT メッセージを送信します。

更新領域のいずれかの部分について bErase パラメーターが TRUE である場合、指定した部分だけでなく、領域全体の背景が消去されます。

例

例については、クライアント領域の無効化を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

BOOL InvalidateRect(
    HWND hWnd,   // optional
    const RECT* lpRect,   // optional
    BOOL bErase
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool InvalidateRect(
    IntPtr hWnd,   // HWND optional
    IntPtr lpRect,   // RECT* optional
    bool bErase   // BOOL
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function InvalidateRect(
    hWnd As IntPtr,   ' HWND optional
    lpRect As IntPtr,   ' RECT* optional
    bErase As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hWnd : HWND optional
' lpRect : RECT* optional
' bErase : BOOL
Declare PtrSafe Function InvalidateRect Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpRect As LongPtr, _
    ByVal bErase As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InvalidateRect = ctypes.windll.user32.InvalidateRect
InvalidateRect.restype = wintypes.BOOL
InvalidateRect.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND optional
    ctypes.c_void_p,  # lpRect : RECT* optional
    wintypes.BOOL,  # bErase : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
InvalidateRect = Fiddle::Function.new(
  lib['InvalidateRect'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    Fiddle::TYPE_VOIDP,  # lpRect : RECT* optional
    Fiddle::TYPE_INT,  # bErase : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn InvalidateRect(
        hWnd: *mut core::ffi::c_void,  // HWND optional
        lpRect: *const RECT,  // RECT* optional
        bErase: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool InvalidateRect(IntPtr hWnd, IntPtr lpRect, bool bErase);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_InvalidateRect' -Namespace Win32 -PassThru
# $api::InvalidateRect(hWnd, lpRect, bErase)

#uselib "USER32.dll"
#func global InvalidateRect "InvalidateRect" sptr, sptr, sptr
; InvalidateRect hWnd, varptr(lpRect), bErase   ; 戻り値は stat
; hWnd : HWND optional -> "sptr"
; lpRect : RECT* optional -> "sptr"
; bErase : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global InvalidateRect "InvalidateRect" sptr, var, int
; res = InvalidateRect(hWnd, lpRect, bErase)
; hWnd : HWND optional -> "sptr"
; lpRect : RECT* optional -> "var"
; bErase : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global InvalidateRect "InvalidateRect" sptr, sptr, int
; res = InvalidateRect(hWnd, varptr(lpRect), bErase)
; hWnd : HWND optional -> "sptr"
; lpRect : RECT* optional -> "sptr"
; bErase : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。