GetBoundsRect

関数

DCの累積描画境界矩形を取得する。

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

シグネチャ

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

DWORD GetBoundsRect(
    HDC hdc,
    RECT* lprect,
    DWORD flags
);

パラメーター

名前

型

方向

説明

hdc

HDC

関数が境界矩形を返す対象となるデバイスコンテキストへのハンドル。

lprect

RECT*

out

現在の境界矩形を受け取る RECT 構造体へのポインター。アプリケーションの矩形は論理座標で返され、境界矩形はスクリーン座標で返されます。

flags

DWORD

GetBoundsRect 関数の動作を指定します。このパラメーターには次の値を指定できます。

値	意味
DCB_RESET	境界矩形を返した後にクリアします。このフラグが設定されていない場合、境界矩形はクリアされません。

戻り値の型: DWORD

公式ドキュメント

GetBoundsRect 関数は、指定したデバイスコンテキストについて、現在累積されている境界矩形を取得します。

戻り値

戻り値は、累積された境界矩形の状態を示し、次のいずれかの値になります。

値	意味
0	エラーが発生しました。指定したデバイスコンテキストハンドルが無効です。
DCB_DISABLE	境界の累積がオフです。
DCB_ENABLE	境界の累積がオンです。
DCB_RESET	境界矩形が空です。
DCB_SET	境界矩形が空ではありません。

解説(Remarks)

DCB_SET 値は、ビット値 DCB_ACCUMULATE と DCB_RESET を組み合わせたものです。境界矩形が空かどうかを判定するために DCB_RESET ビットを調べるアプリケーションは、DCB_ACCUMULATE ビットも調べる必要があります。境界矩形が空であるのは、DCB_RESET ビットが 1 かつ DCB_ACCUMULATE ビットが 0 の場合のみです。

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

各言語での呼び出し定義

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

DWORD GetBoundsRect(
    HDC hdc,
    RECT* lprect,
    DWORD flags
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GetBoundsRect(
    IntPtr hdc,   // HDC
    IntPtr lprect,   // RECT* out
    uint flags   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetBoundsRect(
    hdc As IntPtr,   ' HDC
    lprect As IntPtr,   ' RECT* out
    flags As UInteger   ' DWORD
) As UInteger
End Function

' hdc : HDC
' lprect : RECT* out
' flags : DWORD
Declare PtrSafe Function GetBoundsRect Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lprect As LongPtr, _
    ByVal flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetBoundsRect = ctypes.windll.gdi32.GetBoundsRect
GetBoundsRect.restype = wintypes.DWORD
GetBoundsRect.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # lprect : RECT* out
    wintypes.DWORD,  # flags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetBoundsRect = Fiddle::Function.new(
  lib['GetBoundsRect'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lprect : RECT* out
    -Fiddle::TYPE_INT,  # flags : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetBoundsRect(
        hdc: *mut core::ffi::c_void,  // HDC
        lprect: *mut RECT,  // RECT* out
        flags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern uint GetBoundsRect(IntPtr hdc, IntPtr lprect, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetBoundsRect' -Namespace Win32 -PassThru
# $api::GetBoundsRect(hdc, lprect, flags)

#uselib "GDI32.dll"
#func global GetBoundsRect "GetBoundsRect" sptr, sptr, sptr
; GetBoundsRect hdc, varptr(lprect), flags   ; 戻り値は stat
; hdc : HDC -> "sptr"
; lprect : RECT* out -> "sptr"
; flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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