Win32 API 日本語リファレンス
ホームDevices.Display › CLIPOBJ_cEnumStart

CLIPOBJ_cEnumStart

関数
クリップオブジェクトの領域列挙を開始する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD CLIPOBJ_cEnumStart(
    CLIPOBJ* pco,
    BOOL bAll,
    DWORD iType,
    DWORD iDirection,
    DWORD cLimit
);

パラメーター

名前方向説明
pcoCLIPOBJ*inout列挙対象のクリップ領域を定義する CLIPOBJ 構造体へのポインターです。
bAllBOOLin

領域全体を列挙するかどうかを指定します。領域全体を列挙する場合、このパラメーターは TRUE です。現在の描画操作に関係する部分のみを列挙する場合は FALSE です。

クリップ領域をキャッシュするドライバーは、領域全体を列挙する必要があります。

iTypeDWORDinCLIPOBJ_bEnum によって書き込まれるデータ構造を指定します。このパラメーターは現在のところ CT_RECTANGLES でなければならず、領域が矩形のリストとして列挙されることを示します。
iDirectionDWORDin

矩形を列挙する順序を決定します。同じサーフェス上で DrvBitBlt 操作が並行して実行されている場合、この順序が重要になることがあります。順序がデバイスドライバーにとって重要でない場合は、複雑な領域に対して CD_ANY を指定し、GDI が列挙を最適化できるようにします。この値には、次のいずれかを指定できます。

意味
CD_ANY GDI にとって都合のよい任意の順序。
CD_LEFTDOWN 右から左、上から下。
CD_LEFTUP 右から左、下から上。
CD_RIGHTDOWN 左から右、上から下。
CD_RIGHTUP 左から右、下から上。
cLimitDWORDin列挙する矩形の最大数を指定します。このパラメーターが 0 の場合、カウントは省略されます。

戻り値の型: DWORD

公式ドキュメント

CLIPOBJ_cEnumStart 関数は、指定されたクリップ領域内の矩形を列挙するためのパラメーターを設定します。

戻り値

戻り値は列挙された矩形の数です。カウントが cLimit を超える場合、戻り値は 0xFFFFFFFF になります。

解説(Remarks)

この関数が呼び出されたかどうかにかかわらず、領域を列挙できます。既定では、ドライバーは関連する矩形のみを左上から開始して列挙します。

ドライバーは、この関数を再度呼び出すことで列挙を再開できます。

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

各言語での呼び出し定義

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

DWORD CLIPOBJ_cEnumStart(
    CLIPOBJ* pco,
    BOOL bAll,
    DWORD iType,
    DWORD iDirection,
    DWORD cLimit
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint CLIPOBJ_cEnumStart(
    IntPtr pco,   // CLIPOBJ* in/out
    bool bAll,   // BOOL
    uint iType,   // DWORD
    uint iDirection,   // DWORD
    uint cLimit   // DWORD
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function CLIPOBJ_cEnumStart(
    pco As IntPtr,   ' CLIPOBJ* in/out
    bAll As Boolean,   ' BOOL
    iType As UInteger,   ' DWORD
    iDirection As UInteger,   ' DWORD
    cLimit As UInteger   ' DWORD
) As UInteger
End Function
' pco : CLIPOBJ* in/out
' bAll : BOOL
' iType : DWORD
' iDirection : DWORD
' cLimit : DWORD
Declare PtrSafe Function CLIPOBJ_cEnumStart Lib "gdi32" ( _
    ByVal pco As LongPtr, _
    ByVal bAll As Long, _
    ByVal iType As Long, _
    ByVal iDirection As Long, _
    ByVal cLimit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CLIPOBJ_cEnumStart = ctypes.windll.gdi32.CLIPOBJ_cEnumStart
CLIPOBJ_cEnumStart.restype = wintypes.DWORD
CLIPOBJ_cEnumStart.argtypes = [
    ctypes.c_void_p,  # pco : CLIPOBJ* in/out
    wintypes.BOOL,  # bAll : BOOL
    wintypes.DWORD,  # iType : DWORD
    wintypes.DWORD,  # iDirection : DWORD
    wintypes.DWORD,  # cLimit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procCLIPOBJ_cEnumStart = gdi32.NewProc("CLIPOBJ_cEnumStart")
)

// pco (CLIPOBJ* in/out), bAll (BOOL), iType (DWORD), iDirection (DWORD), cLimit (DWORD)
r1, _, err := procCLIPOBJ_cEnumStart.Call(
	uintptr(pco),
	uintptr(bAll),
	uintptr(iType),
	uintptr(iDirection),
	uintptr(cLimit),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function CLIPOBJ_cEnumStart(
  pco: Pointer;   // CLIPOBJ* in/out
  bAll: BOOL;   // BOOL
  iType: DWORD;   // DWORD
  iDirection: DWORD;   // DWORD
  cLimit: DWORD   // DWORD
): DWORD; stdcall;
  external 'GDI32.dll' name 'CLIPOBJ_cEnumStart';
result := DllCall("GDI32\CLIPOBJ_cEnumStart"
    , "Ptr", pco   ; CLIPOBJ* in/out
    , "Int", bAll   ; BOOL
    , "UInt", iType   ; DWORD
    , "UInt", iDirection   ; DWORD
    , "UInt", cLimit   ; DWORD
    , "UInt")   ; return: DWORD
●CLIPOBJ_cEnumStart(pco, bAll, iType, iDirection, cLimit) = DLL("GDI32.dll", "dword CLIPOBJ_cEnumStart(void*, bool, dword, dword, dword)")
# 呼び出し: CLIPOBJ_cEnumStart(pco, bAll, iType, iDirection, cLimit)
# pco : CLIPOBJ* in/out -> "void*"
# bAll : BOOL -> "bool"
# iType : DWORD -> "dword"
# iDirection : DWORD -> "dword"
# cLimit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CLIPOBJ_cEnumStartNative = Uint32 Function(Pointer<Void>, Int32, Uint32, Uint32, Uint32);
typedef CLIPOBJ_cEnumStartDart = int Function(Pointer<Void>, int, int, int, int);
final CLIPOBJ_cEnumStart = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<CLIPOBJ_cEnumStartNative, CLIPOBJ_cEnumStartDart>('CLIPOBJ_cEnumStart');
// pco : CLIPOBJ* in/out -> Pointer<Void>
// bAll : BOOL -> Int32
// iType : DWORD -> Uint32
// iDirection : DWORD -> Uint32
// cLimit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CLIPOBJ_cEnumStart(
  pco: Pointer;   // CLIPOBJ* in/out
  bAll: BOOL;   // BOOL
  iType: DWORD;   // DWORD
  iDirection: DWORD;   // DWORD
  cLimit: DWORD   // DWORD
): DWORD; stdcall;
  external 'GDI32.dll' name 'CLIPOBJ_cEnumStart';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CLIPOBJ_cEnumStart"
  c_CLIPOBJ_cEnumStart :: Ptr () -> CInt -> Word32 -> Word32 -> Word32 -> IO Word32
-- pco : CLIPOBJ* in/out -> Ptr ()
-- bAll : BOOL -> CInt
-- iType : DWORD -> Word32
-- iDirection : DWORD -> Word32
-- cLimit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let clipobj_cenumstart =
  foreign "CLIPOBJ_cEnumStart"
    ((ptr void) @-> int32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* pco : CLIPOBJ* in/out -> (ptr void) *)
(* bAll : BOOL -> int32_t *)
(* iType : DWORD -> uint32_t *)
(* iDirection : DWORD -> uint32_t *)
(* cLimit : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("CLIPOBJ_cEnumStart" clipobj-c-enum-start :convention :stdcall) :uint32
  (pco :pointer)   ; CLIPOBJ* in/out
  (b-all :int32)   ; BOOL
  (i-type :uint32)   ; DWORD
  (i-direction :uint32)   ; DWORD
  (c-limit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CLIPOBJ_cEnumStart = Win32::API::More->new('GDI32',
    'DWORD CLIPOBJ_cEnumStart(LPVOID pco, BOOL bAll, DWORD iType, DWORD iDirection, DWORD cLimit)');
# my $ret = $CLIPOBJ_cEnumStart->Call($pco, $bAll, $iType, $iDirection, $cLimit);
# pco : CLIPOBJ* in/out -> LPVOID
# bAll : BOOL -> BOOL
# iType : DWORD -> DWORD
# iDirection : DWORD -> DWORD
# cLimit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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