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

GetClipBox

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

シグネチャ

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

GDI_REGION_TYPE GetClipBox(
    HDC hdc,
    RECT* lprect
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
lprectRECT*out矩形の寸法を論理単位で受け取る RECT 構造体へのポインター。

戻り値の型: GDI_REGION_TYPE

公式ドキュメント

GetClipBox 関数は、デバイス上で現在表示されている領域の周囲に描画できる最小の外接矩形の寸法を取得します。

戻り値

関数が成功した場合、戻り値はクリッピングボックスの複雑さを示し、次のいずれかの値になります。

戻り値 説明
NULLREGION
領域が空です。
SIMPLEREGION
領域が単一の矩形です。
COMPLEXREGION
領域が複数の矩形で構成されています。
ERROR
エラーが発生しました。

GetClipBox は、指定されたデバイスコンテキストに基づく論理座標を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetClipBox(
    HDC hdc,
    RECT* lprect
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int GetClipBox(
    IntPtr hdc,   // HDC
    IntPtr lprect   // RECT* out
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetClipBox(
    hdc As IntPtr,   ' HDC
    lprect As IntPtr   ' RECT* out
) As Integer
End Function
' hdc : HDC
' lprect : RECT* out
Declare PtrSafe Function GetClipBox Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lprect As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetClipBox = ctypes.windll.gdi32.GetClipBox
GetClipBox.restype = ctypes.c_int
GetClipBox.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # lprect : RECT* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetClipBox = gdi32.NewProc("GetClipBox")
)

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

extern "gdi32" fn GetClipBox(
    hdc: ?*anyopaque, // HDC
    lprect: [*c]RECT // RECT* out
) callconv(std.os.windows.WINAPI) i32;
proc GetClipBox(
    hdc: pointer,  # HDC
    lprect: ptr RECT  # RECT* out
): int32 {.importc: "GetClipBox", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int GetClipBox(
    void* hdc,   // HDC
    RECT* lprect   // RECT* out
);
ccall((:GetClipBox, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{RECT}),
      hdc, lprect)
# hdc : HDC -> Ptr{Cvoid}
# lprect : RECT* out -> Ptr{RECT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetClipBox(
    void* hdc,
    void* lprect);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetClipBox(hdc, lprect)
-- hdc : HDC
-- lprect : RECT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetClipBox = lib.func('__stdcall', 'GetClipBox', 'int32_t', ['void *', 'void *']);
// GetClipBox(hdc, lprect)
// hdc : HDC -> 'void *'
// lprect : RECT* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetClipBox: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetClipBox(hdc, lprect)
// hdc : HDC -> "pointer"
// lprect : RECT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetClipBox(
    void* hdc,
    void* lprect);
C, "GDI32.dll");
// $ffi->GetClipBox(hdc, lprect);
// hdc : HDC
// lprect : 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 GetClipBox(
        Pointer hdc,   // HDC
        Pointer lprect   // RECT* out
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun GetClipBox = GetClipBox(
    hdc : Void*,   # HDC
    lprect : 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 GetClipBoxNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef GetClipBoxDart = int Function(Pointer<Void>, Pointer<Void>);
final GetClipBox = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetClipBoxNative, GetClipBoxDart>('GetClipBox');
// hdc : HDC -> Pointer<Void>
// lprect : RECT* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetClipBox(
  hdc: THandle;   // HDC
  lprect: Pointer   // RECT* out
): Integer; stdcall;
  external 'GDI32.dll' name 'GetClipBox';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getclipbox =
  foreign "GetClipBox"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* lprect : 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 ("GetClipBox" get-clip-box :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (lprect :pointer))   ; RECT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetClipBox = Win32::API::More->new('GDI32',
    'int GetClipBox(HANDLE hdc, LPVOID lprect)');
# my $ret = $GetClipBox->Call($hdc, $lprect);
# hdc : HDC -> HANDLE
# lprect : RECT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型