PATHOBJ_bEnum

関数

パスオブジェクトのパスデータを順に列挙する。

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

シグネチャ

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

BOOL PATHOBJ_bEnum(
    PATHOBJ* ppo,
    PATHDATA* ppd
);

パラメーター

名前	型	方向	説明
ppo	PATHOBJ*	inout	曲線および/または線を列挙する対象の PATHOBJ 構造体へのポインターです。
ppd	PATHDATA*	inout	値を格納する PATHDATA 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

PATHOBJ_bEnum 関数は、指定されたパスから次の PATHDATA レコードを取得し、パス内の曲線を列挙します。

戻り値

指定されたパスにさらに PATHDATA レコードが含まれており、このサービスを再度呼び出す必要があることを示す場合、戻り値は TRUE です。それ以外の場合、つまり出力がパス内の最後の PATHDATA レコードである場合、戻り値は FALSE です。

解説(Remarks)

PATHOBJ_bEnum は、PATHOBJ_vEnumStart の呼び出しが行われた後にのみ呼び出すことができます。

PATHDATA 構造体は、サブパス(パスの連結された一部)の全体または一部を記述します。たとえば、パス内でアプリケーションが MoveTo を呼び出すと、新しいサブパスが開始されます。

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

各言語での呼び出し定義

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

BOOL PATHOBJ_bEnum(
    PATHOBJ* ppo,
    PATHDATA* ppd
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool PATHOBJ_bEnum(
    IntPtr ppo,   // PATHOBJ* in/out
    IntPtr ppd   // PATHDATA* in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function PATHOBJ_bEnum(
    ppo As IntPtr,   ' PATHOBJ* in/out
    ppd As IntPtr   ' PATHDATA* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ppo : PATHOBJ* in/out
' ppd : PATHDATA* in/out
Declare PtrSafe Function PATHOBJ_bEnum Lib "gdi32" ( _
    ByVal ppo As LongPtr, _
    ByVal ppd As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PATHOBJ_bEnum = ctypes.windll.gdi32.PATHOBJ_bEnum
PATHOBJ_bEnum.restype = wintypes.BOOL
PATHOBJ_bEnum.argtypes = [
    ctypes.c_void_p,  # ppo : PATHOBJ* in/out
    ctypes.c_void_p,  # ppd : PATHDATA* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
PATHOBJ_bEnum = Fiddle::Function.new(
  lib['PATHOBJ_bEnum'],
  [
    Fiddle::TYPE_VOIDP,  # ppo : PATHOBJ* in/out
    Fiddle::TYPE_VOIDP,  # ppd : PATHDATA* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn PATHOBJ_bEnum(
        ppo: *mut PATHOBJ,  // PATHOBJ* in/out
        ppd: *mut PATHDATA  // PATHDATA* 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 PATHOBJ_bEnum(IntPtr ppo, IntPtr ppd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_PATHOBJ_bEnum' -Namespace Win32 -PassThru
# $api::PATHOBJ_bEnum(ppo, ppd)

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

出力引数:

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