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

SelectClipRgn

関数
指定した領域をクリッピング領域に設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

GDI_REGION_TYPE SelectClipRgn(
    HDC hdc,
    HRGN hrgn   // optional
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
hrgnHRGNinoptional選択する領域へのハンドル。

戻り値の型: GDI_REGION_TYPE

公式ドキュメント

SelectClipRgn 関数は、指定したデバイスコンテキストの現在のクリッピング領域として、ある領域を選択します。

戻り値

戻り値は領域の複雑さを示し、次のいずれかの値になります。

戻り値 説明
NULLREGION
領域は空です。
SIMPLEREGION
領域は単一の矩形です。
COMPLEXREGION
領域は複数の矩形で構成されます。
ERROR
エラーが発生しました。(以前のクリッピング領域は影響を受けません。)

解説(Remarks)

選択した領域のコピーのみが使用されます。領域自体は、他の任意の数のデバイスコンテキストに対して選択することも、削除することもできます。

SelectClipRgn 関数は、領域の座標がデバイス単位で指定されていることを前提とします。

デバイスコンテキストのクリッピング領域を削除するには、NULL の領域ハンドルを指定します。

使用例

例については、Clipping Output を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SelectClipRgn(
    HDC hdc,
    HRGN hrgn   // optional
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int SelectClipRgn(
    IntPtr hdc,   // HDC
    IntPtr hrgn   // HRGN optional
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SelectClipRgn(
    hdc As IntPtr,   ' HDC
    hrgn As IntPtr   ' HRGN optional
) As Integer
End Function
' hdc : HDC
' hrgn : HRGN optional
Declare PtrSafe Function SelectClipRgn 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

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

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSelectClipRgn = gdi32.NewProc("SelectClipRgn")
)

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

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

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

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

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

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

関連項目

公式の関連項目
使用する型