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

GetRgnBox

関数
領域を囲む最小矩形を取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

GDI_REGION_TYPE GetRgnBox(
    HRGN hrgn,
    RECT* lprc
);

パラメーター

名前方向説明
hrgnHRGNinリージョンへのハンドル。
lprcRECT*out境界矩形を論理単位で受け取る RECT 構造体へのポインター。

戻り値の型: GDI_REGION_TYPE

公式ドキュメント

GetRgnBox 関数は、指定されたリージョンの境界矩形を取得します。

戻り値

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

意味
NULLREGION リージョンが空です。
SIMPLEREGION リージョンは単一の矩形です。
COMPLEXREGION リージョンは単一の矩形ではなく、複数で構成されています。

hrgn パラメーターが有効なリージョンを識別しない場合、戻り値は 0 になります。

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

各言語での呼び出し定義

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

GDI_REGION_TYPE GetRgnBox(
    HRGN hrgn,
    RECT* lprc
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int GetRgnBox(
    IntPtr hrgn,   // HRGN
    IntPtr lprc   // RECT* out
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetRgnBox(
    hrgn As IntPtr,   ' HRGN
    lprc As IntPtr   ' RECT* out
) As Integer
End Function
' hrgn : HRGN
' lprc : RECT* out
Declare PtrSafe Function GetRgnBox Lib "gdi32" ( _
    ByVal hrgn 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

GetRgnBox = ctypes.windll.gdi32.GetRgnBox
GetRgnBox.restype = ctypes.c_int
GetRgnBox.argtypes = [
    wintypes.HANDLE,  # hrgn : HRGN
    ctypes.c_void_p,  # lprc : RECT* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetRgnBox = Fiddle::Function.new(
  lib['GetRgnBox'],
  [
    Fiddle::TYPE_VOIDP,  # hrgn : HRGN
    Fiddle::TYPE_VOIDP,  # lprc : RECT* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn GetRgnBox(
        hrgn: *mut core::ffi::c_void,  // HRGN
        lprc: *mut RECT  // RECT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern int GetRgnBox(IntPtr hrgn, IntPtr lprc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetRgnBox' -Namespace Win32 -PassThru
# $api::GetRgnBox(hrgn, lprc)
#uselib "GDI32.dll"
#func global GetRgnBox "GetRgnBox" sptr, sptr
; GetRgnBox hrgn, varptr(lprc)   ; 戻り値は stat
; hrgn : HRGN -> "sptr"
; lprc : RECT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global GetRgnBox "GetRgnBox" sptr, var
; res = GetRgnBox(hrgn, lprc)
; hrgn : HRGN -> "sptr"
; lprc : RECT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; GDI_REGION_TYPE GetRgnBox(HRGN hrgn, RECT* lprc)
#uselib "GDI32.dll"
#cfunc global GetRgnBox "GetRgnBox" intptr, var
; res = GetRgnBox(hrgn, lprc)
; hrgn : HRGN -> "intptr"
; lprc : RECT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetRgnBox = gdi32.NewProc("GetRgnBox")
)

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

extern "gdi32" fn GetRgnBox(
    hrgn: ?*anyopaque, // HRGN
    lprc: [*c]RECT // RECT* out
) callconv(std.os.windows.WINAPI) i32;
proc GetRgnBox(
    hrgn: pointer,  # HRGN
    lprc: ptr RECT  # RECT* out
): int32 {.importc: "GetRgnBox", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int GetRgnBox(
    void* hrgn,   // HRGN
    RECT* lprc   // RECT* out
);
ccall((:GetRgnBox, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{RECT}),
      hrgn, lprc)
# hrgn : HRGN -> Ptr{Cvoid}
# lprc : RECT* out -> Ptr{RECT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetRgnBox(
    void* hrgn,
    void* lprc);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetRgnBox(hrgn, lprc)
-- hrgn : HRGN
-- lprc : RECT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetRgnBox = lib.func('__stdcall', 'GetRgnBox', 'int32_t', ['void *', 'void *']);
// GetRgnBox(hrgn, lprc)
// hrgn : HRGN -> 'void *'
// lprc : RECT* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetRgnBox: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetRgnBox(hrgn, lprc)
// hrgn : HRGN -> "pointer"
// lprc : RECT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetRgnBox(
    void* hrgn,
    void* lprc);
C, "GDI32.dll");
// $ffi->GetRgnBox(hrgn, lprc);
// hrgn : HRGN
// lprc : RECT* out
// 構造体/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 Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class);
    int GetRgnBox(
        Pointer hrgn,   // HRGN
        Pointer lprc   // RECT* out
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun GetRgnBox = GetRgnBox(
    hrgn : Void*,   # HRGN
    lprc : RECT*   # RECT* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetRgnBoxNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef GetRgnBoxDart = int Function(Pointer<Void>, Pointer<Void>);
final GetRgnBox = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetRgnBoxNative, GetRgnBoxDart>('GetRgnBox');
// hrgn : HRGN -> Pointer<Void>
// lprc : RECT* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetRgnBox(
  hrgn: THandle;   // HRGN
  lprc: Pointer   // RECT* out
): Integer; stdcall;
  external 'GDI32.dll' name 'GetRgnBox';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetRgnBox"
  c_GetRgnBox :: Ptr () -> Ptr () -> IO Int32
-- hrgn : HRGN -> Ptr ()
-- lprc : RECT* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getrgnbox =
  foreign "GetRgnBox"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hrgn : HRGN -> (ptr void) *)
(* lprc : RECT* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("GetRgnBox" get-rgn-box :convention :stdcall) :int32
  (hrgn :pointer)   ; HRGN
  (lprc :pointer))   ; RECT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetRgnBox = Win32::API::More->new('GDI32',
    'int GetRgnBox(HANDLE hrgn, LPVOID lprc)');
# my $ret = $GetRgnBox->Call($hrgn, $lprc);
# hrgn : HRGN -> HANDLE
# lprc : RECT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型