ValidateRect

関数

指定矩形を有効化して更新領域から除外する。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
hWnd	HWND	inoptional	更新領域を変更するウィンドウへのハンドル。このパラメーターが NULL の場合、システムはすべてのウィンドウを無効化して再描画し、関数が戻る前にウィンドウプロシージャへ WM_ERASEBKGND および WM_NCPAINT メッセージを送信します。
lpRect	RECT*	inoptional	更新領域から取り除く矩形のクライアント座標を格納した RECT 構造体へのポインター。このパラメーターが NULL の場合、クライアント領域全体が取り除かれます。

戻り値の型: BOOL

公式ドキュメント

ValidateRect 関数は、指定した矩形を対象ウィンドウの更新領域から取り除くことで、その矩形内のクライアント領域を有効化します。

戻り値

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

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

解説(Remarks)

BeginPaint 関数は、クライアント領域全体を自動的に有効化します。次の WM_PAINT メッセージが生成される前に更新領域の一部を有効化する必要がある場合は、ValidateRect 関数も ValidateRgn 関数も呼び出さないでください。

システムは、現在の更新領域が有効化されるまで WM_PAINT メッセージを生成し続けます。

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

各言語での呼び出し定義

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

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

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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