STROBJ_bEnum

関数

文字列オブジェクトのグリフ位置情報を順に列挙する。

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

シグネチャ

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

BOOL STROBJ_bEnum(
    STROBJ* pstro,
    DWORD* pc,
    GLYPHPOS** ppgpos
);

パラメーター

名前	型	方向	説明
pstro	STROBJ*	inout	STROBJ 構造体へのポインター。GLYPHPOS 情報を格納しています。
pc	DWORD*	inout	GDI によって返される GLYPHPOS 構造体の数を受け取るポインター。
ppgpos	GLYPHPOS**	inout	GDI が GLYPHPOS 構造体を書き込む配列へのポインター。

戻り値の型: BOOL

公式ドキュメント

STROBJ_bEnum 関数は、グリフの識別子と位置を列挙します。

戻り値

列挙すべきグリフがまだ残っている場合は戻り値が TRUE、列挙が完了した場合は FALSE になります。グリフを列挙できない場合は戻り値が DDI_ERROR となり、エラーコードがログに記録されます。

解説(Remarks)

ドライバーが自身でフォントをキャッシュする場合は、グリフハンドルのみをダウンロードしてください。

返される情報は、DrvGetGlyphMode に対するドライバーの戻り値によって異なります。

ビットマップやアウトラインは、FONTOBJ 構造体からも取得できます。

プリンターハードウェアが TrueType フォントの内部レンダリングを提供する場合、プリンタードライバーは STROBJ_bEnum ではなく STROBJ_bEnumPositionsOnly を呼び出してください。

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

各言語での呼び出し定義

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

BOOL STROBJ_bEnum(
    STROBJ* pstro,
    DWORD* pc,
    GLYPHPOS** ppgpos
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool STROBJ_bEnum(
    IntPtr pstro,   // STROBJ* in/out
    ref uint pc,   // DWORD* in/out
    IntPtr ppgpos   // GLYPHPOS** in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function STROBJ_bEnum(
    pstro As IntPtr,   ' STROBJ* in/out
    ByRef pc As UInteger,   ' DWORD* in/out
    ppgpos As IntPtr   ' GLYPHPOS** in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pstro : STROBJ* in/out
' pc : DWORD* in/out
' ppgpos : GLYPHPOS** in/out
Declare PtrSafe Function STROBJ_bEnum Lib "gdi32" ( _
    ByVal pstro As LongPtr, _
    ByRef pc As Long, _
    ByVal ppgpos As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

STROBJ_bEnum = ctypes.windll.gdi32.STROBJ_bEnum
STROBJ_bEnum.restype = wintypes.BOOL
STROBJ_bEnum.argtypes = [
    ctypes.c_void_p,  # pstro : STROBJ* in/out
    ctypes.POINTER(wintypes.DWORD),  # pc : DWORD* in/out
    ctypes.c_void_p,  # ppgpos : GLYPHPOS** in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
STROBJ_bEnum = Fiddle::Function.new(
  lib['STROBJ_bEnum'],
  [
    Fiddle::TYPE_VOIDP,  # pstro : STROBJ* in/out
    Fiddle::TYPE_VOIDP,  # pc : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ppgpos : GLYPHPOS** in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn STROBJ_bEnum(
        pstro: *mut STROBJ,  // STROBJ* in/out
        pc: *mut u32,  // DWORD* in/out
        ppgpos: *mut *mut GLYPHPOS  // GLYPHPOS** 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 STROBJ_bEnum(IntPtr pstro, ref uint pc, IntPtr ppgpos);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_STROBJ_bEnum' -Namespace Win32 -PassThru
# $api::STROBJ_bEnum(pstro, pc, ppgpos)

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

出力引数:

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