SubtractRect

関数

ある矩形から別の矩形を差し引いた矩形を求める。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
lprcDst	RECT*	out	lprcSrc1 が指す矩形から lprcSrc2 が指す矩形を減算して求めた矩形の座標を受け取る RECT 構造体へのポインターです。
lprcSrc1	RECT*	in	lprcSrc2 が指す矩形を減算する元となる RECT 構造体へのポインターです。
lprcSrc2	RECT*	in	lprcSrc1 が指す矩形から減算される RECT 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

SubtractRect 関数は、一方の矩形から他方の矩形を減算して得られる矩形の座標を求めます。

戻り値

結果の矩形が空の場合、戻り値は 0 です。

結果の矩形が空でない場合、戻り値は 0 以外です。

解説(Remarks)

この関数は、2 つの矩形が x 方向または y 方向のいずれかで完全に重なる場合にのみ、lprcSrc1 で指定された矩形から lprcSrc2 で指定された矩形を減算します。たとえば、lprcSrc1 が座標 (10,10,100,100) を持ち、lprcSrc2 が座標 (50,50,150,150) を持つ場合、関数は lprcDst が指す矩形の座標を (10,10,100,100) に設定します。一方、lprcSrc1 が座標 (10,10,100,100) を持ち、lprcSrc2 が座標 (50,10,150,150) を持つ場合は、関数は lprcDst が指す矩形の座標を (10,10,50,100) に設定します。言い換えると、結果の矩形は幾何学的な差分のバウンディングボックスになります。

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

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

各言語での呼び出し定義

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

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

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

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function SubtractRect(
    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 SubtractRect 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

SubtractRect = ctypes.windll.user32.SubtractRect
SubtractRect.restype = wintypes.BOOL
SubtractRect.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')
SubtractRect = Fiddle::Function.new(
  lib['SubtractRect'],
  [
    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 SubtractRect(
        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 SubtractRect(IntPtr lprcDst, IntPtr lprcSrc1, IntPtr lprcSrc2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SubtractRect' -Namespace Win32 -PassThru
# $api::SubtractRect(lprcDst, lprcSrc1, lprcSrc2)

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