Win32 API 日本語リファレンス
ホームGraphics.Gdi › GetUpdateRgn

GetUpdateRgn

関数
ウィンドウの更新が必要な領域をリージョンとして取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

GDI_REGION_TYPE GetUpdateRgn(
    HWND hWnd,
    HRGN hRgn,
    BOOL bErase
);

パラメーター

名前方向説明
hWndHWNDin取得対象の更新リージョンを持つウィンドウのハンドルです。
hRgnHRGNin更新リージョンを受け取るリージョンのハンドルです。
bEraseBOOLinウィンドウの背景を消去するかどうか、および子ウィンドウの非クライアント領域を描画するかどうかを指定します。このパラメーターが FALSE の場合、描画は行われません。

戻り値の型: GDI_REGION_TYPE

公式ドキュメント

GetUpdateRgn 関数は、ウィンドウの更新リージョンを指定したリージョンにコピーして取得します。更新リージョンの座標は、ウィンドウの左上隅を基準とした座標(すなわちクライアント座標)です。

戻り値

戻り値は、得られたリージョンの複雑さを示します。次のいずれかの値になります。

意味
COMPLEXREGION リージョンが複数の四角形で構成されています。
ERROR エラーが発生しました。
NULLREGION リージョンが空です。
SIMPLEREGION リージョンが単一の四角形です。

解説(Remarks)

BeginPaint 関数は更新リージョンを自動的に検証(有効化)するため、BeginPaint の呼び出し直後に GetUpdateRgn を呼び出すと、空の更新リージョンが取得されます。

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

各言語での呼び出し定義

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

GDI_REGION_TYPE GetUpdateRgn(
    HWND hWnd,
    HRGN hRgn,
    BOOL bErase
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern int GetUpdateRgn(
    IntPtr hWnd,   // HWND
    IntPtr hRgn,   // HRGN
    bool bErase   // BOOL
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetUpdateRgn(
    hWnd As IntPtr,   ' HWND
    hRgn As IntPtr,   ' HRGN
    bErase As Boolean   ' BOOL
) As Integer
End Function
' hWnd : HWND
' hRgn : HRGN
' bErase : BOOL
Declare PtrSafe Function GetUpdateRgn 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

GetUpdateRgn = ctypes.windll.user32.GetUpdateRgn
GetUpdateRgn.restype = ctypes.c_int
GetUpdateRgn.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.HANDLE,  # hRgn : HRGN
    wintypes.BOOL,  # bErase : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetUpdateRgn = Fiddle::Function.new(
  lib['GetUpdateRgn'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # hRgn : HRGN
    Fiddle::TYPE_INT,  # bErase : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetUpdateRgn(
        hWnd: *mut core::ffi::c_void,  // HWND
        hRgn: *mut core::ffi::c_void,  // HRGN
        bErase: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern int GetUpdateRgn(IntPtr hWnd, IntPtr hRgn, bool bErase);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetUpdateRgn' -Namespace Win32 -PassThru
# $api::GetUpdateRgn(hWnd, hRgn, bErase)
#uselib "USER32.dll"
#func global GetUpdateRgn "GetUpdateRgn" sptr, sptr, sptr
; GetUpdateRgn hWnd, hRgn, bErase   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; hRgn : HRGN -> "sptr"
; bErase : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetUpdateRgn "GetUpdateRgn" sptr, sptr, int
; res = GetUpdateRgn(hWnd, hRgn, bErase)
; hWnd : HWND -> "sptr"
; hRgn : HRGN -> "sptr"
; bErase : BOOL -> "int"
; GDI_REGION_TYPE GetUpdateRgn(HWND hWnd, HRGN hRgn, BOOL bErase)
#uselib "USER32.dll"
#cfunc global GetUpdateRgn "GetUpdateRgn" intptr, intptr, int
; res = GetUpdateRgn(hWnd, hRgn, bErase)
; hWnd : HWND -> "intptr"
; hRgn : HRGN -> "intptr"
; bErase : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetUpdateRgn = user32.NewProc("GetUpdateRgn")
)

// hWnd (HWND), hRgn (HRGN), bErase (BOOL)
r1, _, err := procGetUpdateRgn.Call(
	uintptr(hWnd),
	uintptr(hRgn),
	uintptr(bErase),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // GDI_REGION_TYPE
function GetUpdateRgn(
  hWnd: THandle;   // HWND
  hRgn: THandle;   // HRGN
  bErase: BOOL   // BOOL
): Integer; stdcall;
  external 'USER32.dll' name 'GetUpdateRgn';
result := DllCall("USER32\GetUpdateRgn"
    , "Ptr", hWnd   ; HWND
    , "Ptr", hRgn   ; HRGN
    , "Int", bErase   ; BOOL
    , "Int")   ; return: GDI_REGION_TYPE
●GetUpdateRgn(hWnd, hRgn, bErase) = DLL("USER32.dll", "int GetUpdateRgn(void*, void*, bool)")
# 呼び出し: GetUpdateRgn(hWnd, hRgn, bErase)
# hWnd : HWND -> "void*"
# hRgn : HRGN -> "void*"
# bErase : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetUpdateRgn(
    hWnd: ?*anyopaque, // HWND
    hRgn: ?*anyopaque, // HRGN
    bErase: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc GetUpdateRgn(
    hWnd: pointer,  # HWND
    hRgn: pointer,  # HRGN
    bErase: int32  # BOOL
): int32 {.importc: "GetUpdateRgn", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int GetUpdateRgn(
    void* hWnd,   // HWND
    void* hRgn,   // HRGN
    int bErase   // BOOL
);
ccall((:GetUpdateRgn, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Int32),
      hWnd, hRgn, bErase)
# hWnd : HWND -> Ptr{Cvoid}
# hRgn : HRGN -> Ptr{Cvoid}
# bErase : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetUpdateRgn(
    void* hWnd,
    void* hRgn,
    int32_t bErase);
]]
local user32 = ffi.load("user32")
-- user32.GetUpdateRgn(hWnd, hRgn, bErase)
-- hWnd : HWND
-- hRgn : HRGN
-- bErase : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetUpdateRgn = lib.func('__stdcall', 'GetUpdateRgn', 'int32_t', ['void *', 'void *', 'int32_t']);
// GetUpdateRgn(hWnd, hRgn, bErase)
// hWnd : HWND -> 'void *'
// hRgn : HRGN -> 'void *'
// bErase : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetUpdateRgn: { parameters: ["pointer", "pointer", "i32"], result: "i32" },
});
// lib.symbols.GetUpdateRgn(hWnd, hRgn, bErase)
// hWnd : HWND -> "pointer"
// hRgn : HRGN -> "pointer"
// bErase : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetUpdateRgn(
    void* hWnd,
    void* hRgn,
    int32_t bErase);
C, "USER32.dll");
// $ffi->GetUpdateRgn(hWnd, hRgn, bErase);
// hWnd : HWND
// hRgn : HRGN
// 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);
    int GetUpdateRgn(
        Pointer hWnd,   // HWND
        Pointer hRgn,   // HRGN
        boolean bErase   // BOOL
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetUpdateRgn = GetUpdateRgn(
    hWnd : Void*,   # HWND
    hRgn : Void*,   # HRGN
    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 GetUpdateRgnNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32);
typedef GetUpdateRgnDart = int Function(Pointer<Void>, Pointer<Void>, int);
final GetUpdateRgn = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetUpdateRgnNative, GetUpdateRgnDart>('GetUpdateRgn');
// hWnd : HWND -> Pointer<Void>
// hRgn : HRGN -> Pointer<Void>
// bErase : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetUpdateRgn(
  hWnd: THandle;   // HWND
  hRgn: THandle;   // HRGN
  bErase: BOOL   // BOOL
): Integer; stdcall;
  external 'USER32.dll' name 'GetUpdateRgn';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetUpdateRgn"
  c_GetUpdateRgn :: Ptr () -> Ptr () -> CInt -> IO Int32
-- hWnd : HWND -> Ptr ()
-- hRgn : HRGN -> Ptr ()
-- bErase : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getupdatergn =
  foreign "GetUpdateRgn"
    ((ptr void) @-> (ptr void) @-> int32_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* hRgn : HRGN -> (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 ("GetUpdateRgn" get-update-rgn :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (h-rgn :pointer)   ; HRGN
  (b-erase :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetUpdateRgn = Win32::API::More->new('USER32',
    'int GetUpdateRgn(HANDLE hWnd, HANDLE hRgn, BOOL bErase)');
# my $ret = $GetUpdateRgn->Call($hWnd, $hRgn, $bErase);
# hWnd : HWND -> HANDLE
# hRgn : HRGN -> HANDLE
# bErase : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型