GetWindowRgnBox

関数

ウィンドウリージョンの外接矩形を取得する。

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

シグネチャ

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

GDI_REGION_TYPE GetWindowRgnBox(
    HWND hWnd,
    RECT* lprc
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	ウィンドウへのハンドルです。
lprc	RECT*	out	矩形の寸法を受け取る RECT 構造体へのポインターです。寸法は、ウィンドウの左上隅を基準としたデバイス単位で表されます。

戻り値の型: GDI_REGION_TYPE

公式ドキュメント

GetWindowRgnBox 関数は、ウィンドウのウィンドウリージョンを囲む最小の境界矩形の寸法を取得します。

戻り値

戻り値は、この関数が取得したリージョンの種類を示します。次のいずれかの値になります。

値	意味
COMPLEXREGION	リージョンが複数の矩形で構成されています。
ERROR	指定したウィンドウにリージョンが存在しないか、リージョンを返す処理中にエラーが発生しました。
NULLREGION	リージョンが空です。
SIMPLEREGION	リージョンが単一の矩形です。

解説(Remarks)

ウィンドウリージョンは、システムが描画を許可するウィンドウ内の領域を決定します。システムは、ウィンドウリージョンの外側にあるウィンドウの部分を一切表示しません。ウィンドウのウィンドウリージョンの座標は、ウィンドウのクライアント領域ではなく、ウィンドウの左上隅を基準とします。

ウィンドウのウィンドウリージョンを設定するには、SetWindowRgn 関数を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetWindowRgnBox(
    HWND hWnd,
    RECT* lprc
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern int GetWindowRgnBox(
    IntPtr hWnd,   // HWND
    IntPtr lprc   // RECT* out
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetWindowRgnBox(
    hWnd As IntPtr,   ' HWND
    lprc As IntPtr   ' RECT* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

GetWindowRgnBox = ctypes.windll.user32.GetWindowRgnBox
GetWindowRgnBox.restype = ctypes.c_int
GetWindowRgnBox.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # lprc : RECT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetWindowRgnBox = Fiddle::Function.new(
  lib['GetWindowRgnBox'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lprc : RECT* out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("USER32.dll")]
public static extern int GetWindowRgnBox(IntPtr hWnd, IntPtr lprc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetWindowRgnBox' -Namespace Win32 -PassThru
# $api::GetWindowRgnBox(hWnd, lprc)

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

出力引数:

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