SetBoundsRect

関数

DCの境界矩形の累積動作を制御する。

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

シグネチャ

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

DWORD SetBoundsRect(
    HDC hdc,
    const RECT* lprect,   // optional
    SET_BOUNDS_RECT_FLAGS flags
);

パラメーター

名前

型

方向

説明

hdc

HDC

バウンディング矩形を累積する対象のデバイスコンテキストへのハンドル。

lprect

RECT*

inoptional

バウンディング矩形を設定するために使用する RECT 構造体へのポインター。矩形の寸法は論理座標で指定します。このパラメーターには NULL を指定できます。

flags

SET_BOUNDS_RECT_FLAGS

新しい矩形を累積された矩形とどのように組み合わせるかを指定します。このパラメーターには、次の値のうち 1 つ以上を指定できます。

値	意味
DCB_ACCUMULATE	lprcBounds パラメーターで指定された矩形を、バウンディング矩形に(矩形の和演算を使用して)追加します。DCB_RESET と DCB_ACCUMULATE の両方を使用すると、バウンディング矩形は lprcBounds パラメーターで指定された矩形に設定されます。
DCB_DISABLE	境界の累積をオフにします。
DCB_ENABLE	境界の累積をオンにします。既定では無効になっています。
DCB_RESET	バウンディング矩形をクリアします。

戻り値の型: DWORD

公式ドキュメント

SetBoundsRect 関数は、指定されたデバイスコンテキストに対するバウンディング矩形情報の累積を制御します。

戻り値

関数が成功した場合、戻り値はバウンディング矩形の以前の状態を示します。この状態は、次の値の組み合わせになることがあります。

値	意味
DCB_DISABLE	境界の累積がオフです。
DCB_ENABLE	境界の累積がオンです。DCB_ENABLE と DCB_DISABLE は相互に排他的です。
DCB_RESET	バウンディング矩形が空です。
DCB_SET	バウンディング矩形が空ではありません。DCB_SET と DCB_RESET は相互に排他的です。

関数が失敗した場合、戻り値は 0 です。

解説(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 SetBoundsRect(
    HDC hdc,
    const RECT* lprect,   // optional
    SET_BOUNDS_RECT_FLAGS flags
);

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

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

' hdc : HDC
' lprect : RECT* optional
' flags : SET_BOUNDS_RECT_FLAGS
Declare PtrSafe Function SetBoundsRect 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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