ホーム › Graphics.Gdi › InvalidateRgn
InvalidateRgn
関数指定リージョンを無効化して再描画対象に追加する。
シグネチャ
// USER32.dll
#include <windows.h>
BOOL InvalidateRgn(
HWND hWnd,
HRGN hRgn, // optional
BOOL bErase
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hWnd | HWND | in | 更新リージョンを変更する対象ウィンドウへのハンドル。 |
| hRgn | HRGN | inoptional | 更新リージョンに追加するリージョンへのハンドル。リージョンはクライアント座標で指定されているものとみなされます。このパラメーターが NULL の場合、クライアント領域全体が更新リージョンに追加されます。 |
| bErase | BOOL | in | 更新リージョンが処理されるときに、その範囲内の背景を消去するかどうかを指定します。このパラメーターが TRUE の場合、BeginPaint 関数が呼び出されたときに背景が消去されます。FALSE の場合、背景は変更されません。 |
戻り値の型: BOOL
公式ドキュメント
InvalidateRgn 関数は、指定したリージョンをウィンドウの現在の更新リージョンに追加することで、そのリージョン内のクライアント領域を無効化します。
戻り値
戻り値は常に 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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
BOOL InvalidateRgn(
HWND hWnd,
HRGN hRgn, // optional
BOOL bErase
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool InvalidateRgn(
IntPtr hWnd, // HWND
IntPtr hRgn, // HRGN optional
bool bErase // BOOL
);<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function InvalidateRgn(
hWnd As IntPtr, ' HWND
hRgn As IntPtr, ' HRGN optional
bErase As Boolean ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hWnd : HWND
' hRgn : HRGN optional
' bErase : BOOL
Declare PtrSafe Function InvalidateRgn Lib "user32" ( _
ByVal hWnd As LongPtr, _
ByVal hRgn 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
InvalidateRgn = ctypes.windll.user32.InvalidateRgn
InvalidateRgn.restype = wintypes.BOOL
InvalidateRgn.argtypes = [
wintypes.HANDLE, # hWnd : HWND
wintypes.HANDLE, # hRgn : HRGN optional
wintypes.BOOL, # bErase : BOOL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
InvalidateRgn = Fiddle::Function.new(
lib['InvalidateRgn'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
Fiddle::TYPE_VOIDP, # hRgn : HRGN optional
Fiddle::TYPE_INT, # bErase : BOOL
],
Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn InvalidateRgn(
hWnd: *mut core::ffi::c_void, // HWND
hRgn: *mut core::ffi::c_void, // HRGN 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 InvalidateRgn(IntPtr hWnd, IntPtr hRgn, bool bErase);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_InvalidateRgn' -Namespace Win32 -PassThru
# $api::InvalidateRgn(hWnd, hRgn, bErase)#uselib "USER32.dll"
#func global InvalidateRgn "InvalidateRgn" sptr, sptr, sptr
; InvalidateRgn hWnd, hRgn, bErase ; 戻り値は stat
; hWnd : HWND -> "sptr"
; hRgn : HRGN optional -> "sptr"
; bErase : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global InvalidateRgn "InvalidateRgn" sptr, sptr, int
; res = InvalidateRgn(hWnd, hRgn, bErase)
; hWnd : HWND -> "sptr"
; hRgn : HRGN optional -> "sptr"
; bErase : BOOL -> "int"; BOOL InvalidateRgn(HWND hWnd, HRGN hRgn, BOOL bErase)
#uselib "USER32.dll"
#cfunc global InvalidateRgn "InvalidateRgn" intptr, intptr, int
; res = InvalidateRgn(hWnd, hRgn, bErase)
; hWnd : HWND -> "intptr"
; hRgn : HRGN optional -> "intptr"
; bErase : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procInvalidateRgn = user32.NewProc("InvalidateRgn")
)
// hWnd (HWND), hRgn (HRGN optional), bErase (BOOL)
r1, _, err := procInvalidateRgn.Call(
uintptr(hWnd),
uintptr(hRgn),
uintptr(bErase),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction InvalidateRgn(
hWnd: THandle; // HWND
hRgn: THandle; // HRGN optional
bErase: BOOL // BOOL
): BOOL; stdcall;
external 'USER32.dll' name 'InvalidateRgn';result := DllCall("USER32\InvalidateRgn"
, "Ptr", hWnd ; HWND
, "Ptr", hRgn ; HRGN optional
, "Int", bErase ; BOOL
, "Int") ; return: BOOL●InvalidateRgn(hWnd, hRgn, bErase) = DLL("USER32.dll", "bool InvalidateRgn(void*, void*, bool)")
# 呼び出し: InvalidateRgn(hWnd, hRgn, bErase)
# hWnd : HWND -> "void*"
# hRgn : HRGN optional -> "void*"
# bErase : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn InvalidateRgn(
hWnd: ?*anyopaque, // HWND
hRgn: ?*anyopaque, // HRGN optional
bErase: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;proc InvalidateRgn(
hWnd: pointer, # HWND
hRgn: pointer, # HRGN optional
bErase: int32 # BOOL
): int32 {.importc: "InvalidateRgn", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
int InvalidateRgn(
void* hWnd, // HWND
void* hRgn, // HRGN optional
int bErase // BOOL
);ccall((:InvalidateRgn, "USER32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, Int32),
hWnd, hRgn, bErase)
# hWnd : HWND -> Ptr{Cvoid}
# hRgn : HRGN optional -> Ptr{Cvoid}
# bErase : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t InvalidateRgn(
void* hWnd,
void* hRgn,
int32_t bErase);
]]
local user32 = ffi.load("user32")
-- user32.InvalidateRgn(hWnd, hRgn, bErase)
-- hWnd : HWND
-- hRgn : HRGN optional
-- bErase : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const InvalidateRgn = lib.func('__stdcall', 'InvalidateRgn', 'int32_t', ['void *', 'void *', 'int32_t']);
// InvalidateRgn(hWnd, hRgn, bErase)
// hWnd : HWND -> 'void *'
// hRgn : HRGN optional -> 'void *'
// bErase : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
InvalidateRgn: { parameters: ["pointer", "pointer", "i32"], result: "i32" },
});
// lib.symbols.InvalidateRgn(hWnd, hRgn, bErase)
// hWnd : HWND -> "pointer"
// hRgn : HRGN optional -> "pointer"
// bErase : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t InvalidateRgn(
void* hWnd,
void* hRgn,
int32_t bErase);
C, "USER32.dll");
// $ffi->InvalidateRgn(hWnd, hRgn, bErase);
// hWnd : HWND
// hRgn : HRGN optional
// bErase : BOOL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface User32 extends StdCallLibrary {
User32 INSTANCE = Native.load("user32", User32.class);
boolean InvalidateRgn(
Pointer hWnd, // HWND
Pointer hRgn, // HRGN optional
boolean bErase // BOOL
);
}@[Link("user32")]
lib LibUSER32
fun InvalidateRgn = InvalidateRgn(
hWnd : Void*, # HWND
hRgn : Void*, # HRGN optional
bErase : Int32 # BOOL
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef InvalidateRgnNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32);
typedef InvalidateRgnDart = int Function(Pointer<Void>, Pointer<Void>, int);
final InvalidateRgn = DynamicLibrary.open('USER32.dll')
.lookupFunction<InvalidateRgnNative, InvalidateRgnDart>('InvalidateRgn');
// hWnd : HWND -> Pointer<Void>
// hRgn : HRGN optional -> Pointer<Void>
// bErase : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function InvalidateRgn(
hWnd: THandle; // HWND
hRgn: THandle; // HRGN optional
bErase: BOOL // BOOL
): BOOL; stdcall;
external 'USER32.dll' name 'InvalidateRgn';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "InvalidateRgn"
c_InvalidateRgn :: Ptr () -> Ptr () -> CInt -> IO CInt
-- hWnd : HWND -> Ptr ()
-- hRgn : HRGN optional -> Ptr ()
-- bErase : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let invalidatergn =
foreign "InvalidateRgn"
((ptr void) @-> (ptr void) @-> int32_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* hRgn : HRGN optional -> (ptr void) *)
(* bErase : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("InvalidateRgn" invalidate-rgn :convention :stdcall) :int32
(h-wnd :pointer) ; HWND
(h-rgn :pointer) ; HRGN optional
(b-erase :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $InvalidateRgn = Win32::API::More->new('USER32',
'BOOL InvalidateRgn(HANDLE hWnd, HANDLE hRgn, BOOL bErase)');
# my $ret = $InvalidateRgn->Call($hWnd, $hRgn, $bErase);
# hWnd : HWND -> HANDLE
# hRgn : HRGN optional -> HANDLE
# bErase : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f BeginPaint — ウィンドウの描画を開始し描画用デバイスコンテキストを取得する。
- f InvalidateRect — 指定矩形を無効化して再描画対象に追加する。
- f ValidateRect — 指定矩形を有効化して更新領域から除外する。
- f ValidateRgn — 指定リージョンを有効化して更新領域から除外する。