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

SelectClipPath

関数
現在のパスを既存のクリッピング領域と結合して選択する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL SelectClipPath(
    HDC hdc,
    RGN_COMBINE_MODE mode
);

パラメーター

名前方向説明
hdcHDCinパスのデバイスコンテキストへのハンドル。
modeRGN_COMBINE_MODEin

パスの使用方法。このパラメーターには次のいずれかの値を指定できます。

Value Meaning
RGN_AND
新しいクリッピング領域には、現在のクリッピング領域と現在のパスの交差部分(重なり合う領域)が含まれます。
RGN_COPY
新しいクリッピング領域は現在のパスになります。
RGN_DIFF
新しいクリッピング領域には、現在のクリッピング領域から現在のパスの領域を除外した領域が含まれます。
RGN_OR
新しいクリッピング領域には、現在のクリッピング領域と現在のパスの和集合(結合された領域)が含まれます。
RGN_XOR
新しいクリッピング領域には、現在のクリッピング領域と現在のパスの和集合が含まれますが、重なり合う領域は除外されます。

戻り値の型: BOOL

公式ドキュメント

SelectClipPath 関数は、現在のパスをデバイスコンテキストのクリッピング領域として選択し、指定したモードを使用して新しい領域を既存のクリッピング領域と結合します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

hdc パラメーターで識別されるデバイスコンテキストには、閉じたパスが含まれている必要があります。

Examples

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

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

各言語での呼び出し定義

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

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

SelectClipPath = ctypes.windll.gdi32.SelectClipPath
SelectClipPath.restype = wintypes.BOOL
SelectClipPath.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # mode : RGN_COMBINE_MODE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSelectClipPath = gdi32.NewProc("SelectClipPath")
)

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

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

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

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

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

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

関連項目

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