CLIPOBJ_bEnum

関数

クリップオブジェクトのクリップ矩形を順に列挙する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL CLIPOBJ_bEnum(
    CLIPOBJ* pco,
    DWORD cj,
    DWORD* pul
);

パラメーター

名前	型	方向	説明
pco	CLIPOBJ*	inout	列挙対象のクリップ領域を記述する CLIPOBJ 構造体へのポインター。
cj	DWORD	in	pv が指すバッファーのサイズをバイト単位で指定します。
pul	DWORD*	inout	クリップ領域に関するデータを ENUMRECTS 構造体として受け取るバッファーへのポインター。

戻り値の型: BOOL

公式ドキュメント

CLIPOBJ_bEnum 関数は、指定したクリップ領域から矩形のバッチを列挙します。列挙の順序は、事前の CLIPOBJ_cEnumStart の呼び出しによって決定されます。

戻り値

ドライバーがさらに列挙データを取得するためにこの関数を再度呼び出す必要がある場合は TRUE、列挙が完了した場合は FALSE が戻り値となります。CLIPOBJ_bEnum がクリッピング矩形の数を 0 として TRUE を返すこともあります。その場合、ドライバーは何も処理を行わずに CLIPOBJ_bEnum を再度呼び出してください。

解説(Remarks)

この関数を呼び出す際のループ構造の例を次に示します。

do {
    bMore = CLIPOBJ_bEnum(pco, sizeof(buffer), &buffer.c);
    for (i = 0; i < buffer.c; i++) {
        .
        .
        .
    }
} while (bMore);

バッファーに書き込まれたオブジェクトの数は、バッファー自体に書き込まれます。

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

各言語での呼び出し定義

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

BOOL CLIPOBJ_bEnum(
    CLIPOBJ* pco,
    DWORD cj,
    DWORD* pul
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool CLIPOBJ_bEnum(
    IntPtr pco,   // CLIPOBJ* in/out
    uint cj,   // DWORD
    ref uint pul   // DWORD* in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function CLIPOBJ_bEnum(
    pco As IntPtr,   ' CLIPOBJ* in/out
    cj As UInteger,   ' DWORD
    ByRef pul As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pco : CLIPOBJ* in/out
' cj : DWORD
' pul : DWORD* in/out
Declare PtrSafe Function CLIPOBJ_bEnum Lib "gdi32" ( _
    ByVal pco As LongPtr, _
    ByVal cj As Long, _
    ByRef pul As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CLIPOBJ_bEnum = ctypes.windll.gdi32.CLIPOBJ_bEnum
CLIPOBJ_bEnum.restype = wintypes.BOOL
CLIPOBJ_bEnum.argtypes = [
    ctypes.c_void_p,  # pco : CLIPOBJ* in/out
    wintypes.DWORD,  # cj : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pul : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
CLIPOBJ_bEnum = Fiddle::Function.new(
  lib['CLIPOBJ_bEnum'],
  [
    Fiddle::TYPE_VOIDP,  # pco : CLIPOBJ* in/out
    -Fiddle::TYPE_INT,  # cj : DWORD
    Fiddle::TYPE_VOIDP,  # pul : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn CLIPOBJ_bEnum(
        pco: *mut CLIPOBJ,  // CLIPOBJ* in/out
        cj: u32,  // DWORD
        pul: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool CLIPOBJ_bEnum(IntPtr pco, uint cj, ref uint pul);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_CLIPOBJ_bEnum' -Namespace Win32 -PassThru
# $api::CLIPOBJ_bEnum(pco, cj, pul)

#uselib "GDI32.dll"
#func global CLIPOBJ_bEnum "CLIPOBJ_bEnum" sptr, sptr, sptr
; CLIPOBJ_bEnum varptr(pco), cj, varptr(pul)   ; 戻り値は stat
; pco : CLIPOBJ* in/out -> "sptr"
; cj : DWORD -> "sptr"
; pul : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global CLIPOBJ_bEnum "CLIPOBJ_bEnum" var, int, var
; res = CLIPOBJ_bEnum(pco, cj, pul)
; pco : CLIPOBJ* in/out -> "var"
; cj : DWORD -> "int"
; pul : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global CLIPOBJ_bEnum "CLIPOBJ_bEnum" sptr, int, sptr
; res = CLIPOBJ_bEnum(varptr(pco), cj, varptr(pul))
; pco : CLIPOBJ* in/out -> "sptr"
; cj : DWORD -> "int"
; pul : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。