ホーム › Devices.Display › STROBJ_bEnumPositionsOnly

STROBJ_bEnumPositionsOnly

関数

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

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
pstro	STROBJ*	inout	テキスト文字列を記述する STROBJ 構造体への、呼び出し側が指定するポインターです。通常、これはドライバーの DrvTextOut 関数が受け取る STROBJ 構造体です。
pc	DWORD*	inout	ppgpos 内のポインターが指す GLYPHPOS 構造体の数を、GDI から受け取るための、呼び出し側が指定するアドレスです。
ppgpos	GLYPHPOS**	inout	GLYPHPOS 構造体の配列への GDI 提供のポインターを受け取る、呼び出し側が指定するアドレスです。(後述の解説セクションを参照してください。)

戻り値の型: BOOL

公式ドキュメント

STROBJ_bEnumPositionsOnly 関数は、指定されたテキスト文字列のグリフの識別子と位置を列挙しますが、キャッシュされたグリフのビットマップは作成しません。

戻り値

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

解説(Remarks)

STROBJ_bEnumPositionsOnly 関数は、通常ドライバーの DrvTextOut 関数内から呼び出されます。この関数は STROBJ_bEnum と同じ処理を実行しますが、1 点だけ重要な相違があります。すなわち、GDI はグリフのキャッシュされたビットマップを作成しません。STROBJ_bEnum 関数は、ドライバーが最終的にこれらのビットマップを必要とすると想定します。しかし、新しいプリンターの多くは内部にラスタライザーを備えているため、グリフのレンダリングを GDI に依存する必要がありません。このようなプリンターでは、サーバーメモリ内でのグリフビットマップの自動レンダリングとキャッシュを省くことで、処理時間とメモリ割り当ての両面で大幅な節約が得られます。

内部でのグリフのラスタライズをサポートするプリンターでは、次の規則に従ってください。

ドライバーは、DEVINFO 構造体に GCAPS_FONT_RASTERIZER フラグを設定してください。
ドライバーの DrvTextOut 関数は、STROBJ_bEnum ではなく STROBJ_bEnumPositionsOnly を呼び出してください。
印刷ジョブにデバイスが内部でラスタライズできないフォントが含まれている場合、ドライバーは FONTOBJ_cGetGlyphs を呼び出してグリフのビットマップを取得してください。
ドライバーがテキスト文字列を印刷した後のプリンターの位置を判定する必要があるものの、フォントのグリフは必要としない場合は、STROBJ_bGetAdvanceWidths を呼び出すことができます。

GDI はグリフのキャッシュされたビットマップを作成しないため、返される各 GLYPHPOS 構造体内の GLYPHDEF 共用体の内容は NULL になります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_bEnumPositionsOnly(
    STROBJ* pstro,
    DWORD* pc,
    GLYPHPOS** ppgpos
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool STROBJ_bEnumPositionsOnly(
    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_bEnumPositionsOnly(
    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_bEnumPositionsOnly 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_bEnumPositionsOnly = ctypes.windll.gdi32.STROBJ_bEnumPositionsOnly
STROBJ_bEnumPositionsOnly.restype = wintypes.BOOL
STROBJ_bEnumPositionsOnly.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_bEnumPositionsOnly = Fiddle::Function.new(
  lib['STROBJ_bEnumPositionsOnly'],
  [
    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_bEnumPositionsOnly(
        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_bEnumPositionsOnly(IntPtr pstro, ref uint pc, IntPtr ppgpos);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_STROBJ_bEnumPositionsOnly' -Namespace Win32 -PassThru
# $api::STROBJ_bEnumPositionsOnly(pstro, pc, ppgpos)

#uselib "GDI32.dll"
#func global STROBJ_bEnumPositionsOnly "STROBJ_bEnumPositionsOnly" sptr, sptr, sptr
; STROBJ_bEnumPositionsOnly 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_bEnumPositionsOnly "STROBJ_bEnumPositionsOnly" var, var, var
; res = STROBJ_bEnumPositionsOnly(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_bEnumPositionsOnly "STROBJ_bEnumPositionsOnly" sptr, sptr, sptr
; res = STROBJ_bEnumPositionsOnly(varptr(pstro), varptr(pc), varptr(ppgpos))
; pstro : STROBJ* in/out -> "sptr"
; pc : DWORD* in/out -> "sptr"
; ppgpos : GLYPHPOS** in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。