UnionRect

関数

二つの矩形を包含する最小の矩形を求める。

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

シグネチャ

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

BOOL UnionRect(
    RECT* lprcDst,
    const RECT* lprcSrc1,
    const RECT* lprcSrc2
);

パラメーター

名前	型	方向	説明
lprcDst	RECT*	out	lprcSrc1 および lprcSrc2 パラメーターが指す四角形を含む四角形を受け取る RECT 構造体へのポインター。
lprcSrc1	RECT*	in	1 つ目の元の四角形を含む RECT 構造体へのポインター。
lprcSrc2	RECT*	in	2 つ目の元の四角形を含む RECT 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

UnionRect 関数は、2 つの四角形の和を作成します。和とは、両方の元の四角形を含む最小の四角形です。

戻り値

指定された構造体が空でない四角形を含む場合、戻り値は 0 以外です。

指定された構造体が空でない四角形を含まない場合、戻り値は 0 です。

解説(Remarks)

システムは、空の四角形、つまりすべての座標が 0 に設定され、高さも幅も持たない四角形の寸法を無視します。

アプリケーションは四角形をさまざまな目的に使用できるため、四角形関数は明示的な測定単位を使用しません。代わりに、すべての四角形の座標および寸法は、符号付きの論理値で指定されます。測定単位は、マッピングモードと、その四角形が使用される関数によって決まります。

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

各言語での呼び出し定義

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

BOOL UnionRect(
    RECT* lprcDst,
    const RECT* lprcSrc1,
    const RECT* lprcSrc2
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool UnionRect(
    IntPtr lprcDst,   // RECT* out
    IntPtr lprcSrc1,   // RECT*
    IntPtr lprcSrc2   // RECT*
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function UnionRect(
    lprcDst As IntPtr,   ' RECT* out
    lprcSrc1 As IntPtr,   ' RECT*
    lprcSrc2 As IntPtr   ' RECT*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

UnionRect = ctypes.windll.user32.UnionRect
UnionRect.restype = wintypes.BOOL
UnionRect.argtypes = [
    ctypes.c_void_p,  # lprcDst : RECT* out
    ctypes.c_void_p,  # lprcSrc1 : RECT*
    ctypes.c_void_p,  # lprcSrc2 : RECT*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
UnionRect = Fiddle::Function.new(
  lib['UnionRect'],
  [
    Fiddle::TYPE_VOIDP,  # lprcDst : RECT* out
    Fiddle::TYPE_VOIDP,  # lprcSrc1 : RECT*
    Fiddle::TYPE_VOIDP,  # lprcSrc2 : RECT*
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn UnionRect(
        lprcDst: *mut RECT,  // RECT* out
        lprcSrc1: *const RECT,  // RECT*
        lprcSrc2: *const RECT  // RECT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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