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

GetClipRgn

関数
DCの現在のクリッピング領域を取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT GetClipRgn(
    HDC hdc,
    HRGN hrgn
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
hrgnHRGNin関数を呼び出す前の、既存の領域へのハンドル。関数が返ると、このパラメーターは現在のクリッピング領域のコピーへのハンドルになります。

戻り値の型: INT

公式ドキュメント

GetClipRgn 関数は、指定されたデバイスコンテキストに対する、現在のアプリケーション定義のクリッピング領域を識別するハンドルを取得します。

戻り値

関数が成功し、指定されたデバイスコンテキストにクリッピング領域が存在しない場合、戻り値は 0 です。関数が成功し、指定されたデバイスコンテキストにクリッピング領域が存在する場合、戻り値は 1 です。エラーが発生した場合、戻り値は -1 です。

解説(Remarks)

アプリケーション定義のクリッピング領域とは、SelectClipRgn 関数によって識別されるクリッピング領域です。これは、アプリケーションが BeginPaint 関数を呼び出したときに作成されるクリッピング領域ではありません。

関数が成功すると、hrgn パラメーターは現在のクリッピング領域のコピーへのハンドルになります。このコピーに対する以降の変更は、現在のクリッピング領域には影響しません。

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

各言語での呼び出し定義

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

INT GetClipRgn(
    HDC hdc,
    HRGN hrgn
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int GetClipRgn(
    IntPtr hdc,   // HDC
    IntPtr hrgn   // HRGN
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetClipRgn(
    hdc As IntPtr,   ' HDC
    hrgn As IntPtr   ' HRGN
) As Integer
End Function
' hdc : HDC
' hrgn : HRGN
Declare PtrSafe Function GetClipRgn Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal hrgn As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetClipRgn = ctypes.windll.gdi32.GetClipRgn
GetClipRgn.restype = ctypes.c_int
GetClipRgn.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.HANDLE,  # hrgn : HRGN
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetClipRgn = Fiddle::Function.new(
  lib['GetClipRgn'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # hrgn : HRGN
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn GetClipRgn(
        hdc: *mut core::ffi::c_void,  // HDC
        hrgn: *mut core::ffi::c_void  // HRGN
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern int GetClipRgn(IntPtr hdc, IntPtr hrgn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetClipRgn' -Namespace Win32 -PassThru
# $api::GetClipRgn(hdc, hrgn)
#uselib "GDI32.dll"
#func global GetClipRgn "GetClipRgn" sptr, sptr
; GetClipRgn hdc, hrgn   ; 戻り値は stat
; hdc : HDC -> "sptr"
; hrgn : HRGN -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global GetClipRgn "GetClipRgn" sptr, sptr
; res = GetClipRgn(hdc, hrgn)
; hdc : HDC -> "sptr"
; hrgn : HRGN -> "sptr"
; INT GetClipRgn(HDC hdc, HRGN hrgn)
#uselib "GDI32.dll"
#cfunc global GetClipRgn "GetClipRgn" intptr, intptr
; res = GetClipRgn(hdc, hrgn)
; hdc : HDC -> "intptr"
; hrgn : HRGN -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetClipRgn = gdi32.NewProc("GetClipRgn")
)

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

extern "gdi32" fn GetClipRgn(
    hdc: ?*anyopaque, // HDC
    hrgn: ?*anyopaque // HRGN
) callconv(std.os.windows.WINAPI) i32;
proc GetClipRgn(
    hdc: pointer,  # HDC
    hrgn: pointer  # HRGN
): int32 {.importc: "GetClipRgn", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int GetClipRgn(
    void* hdc,   // HDC
    void* hrgn   // HRGN
);
ccall((:GetClipRgn, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}),
      hdc, hrgn)
# hdc : HDC -> Ptr{Cvoid}
# hrgn : HRGN -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetClipRgn(
    void* hdc,
    void* hrgn);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetClipRgn(hdc, hrgn)
-- hdc : HDC
-- hrgn : HRGN
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetClipRgn = lib.func('__stdcall', 'GetClipRgn', 'int32_t', ['void *', 'void *']);
// GetClipRgn(hdc, hrgn)
// hdc : HDC -> 'void *'
// hrgn : HRGN -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetClipRgn: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetClipRgn(hdc, hrgn)
// hdc : HDC -> "pointer"
// hrgn : HRGN -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetClipRgn(
    void* hdc,
    void* hrgn);
C, "GDI32.dll");
// $ffi->GetClipRgn(hdc, hrgn);
// hdc : HDC
// hrgn : HRGN
// 構造体/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 GetClipRgn(
        Pointer hdc,   // HDC
        Pointer hrgn   // HRGN
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun GetClipRgn = GetClipRgn(
    hdc : Void*,   # HDC
    hrgn : Void*   # HRGN
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetClipRgnNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef GetClipRgnDart = int Function(Pointer<Void>, Pointer<Void>);
final GetClipRgn = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetClipRgnNative, GetClipRgnDart>('GetClipRgn');
// hdc : HDC -> Pointer<Void>
// hrgn : HRGN -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetClipRgn(
  hdc: THandle;   // HDC
  hrgn: THandle   // HRGN
): Integer; stdcall;
  external 'GDI32.dll' name 'GetClipRgn';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getcliprgn =
  foreign "GetClipRgn"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* hrgn : HRGN -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("GetClipRgn" get-clip-rgn :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (hrgn :pointer))   ; HRGN
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetClipRgn = Win32::API::More->new('GDI32',
    'int GetClipRgn(HANDLE hdc, HANDLE hrgn)');
# my $ret = $GetClipRgn->Call($hdc, $hrgn);
# hdc : HDC -> HANDLE
# hrgn : HRGN -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目