ホーム › Devices.Display › STROBJ_bGetAdvanceWidths

STROBJ_bGetAdvanceWidths

関数

文字列オブジェクトのグリフ送り幅を取得する。

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

シグネチャ

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

BOOL STROBJ_bGetAdvanceWidths(
    STROBJ* pso,
    DWORD iFirst,
    DWORD c,
    POINTQF* pptqD
);

パラメーター

名前	型	方向	説明
pso	STROBJ*	inout	テキスト文字列を記述する STROBJ 構造体への、呼び出し側が指定するポインターです。これは通常、ドライバーの DrvTextOut 関数が受け取る STROBJ 構造体です。
iFirst	DWORD	in	STROBJ 構造体が提供するテキスト文字列に対する、呼び出し側が指定する 0 から始まるインデックスです。このインデックスは、幅を返す対象となる文字列の先頭文字を表します。
c	DWORD	in	iFirst で指定された文字を起点として、幅の値を返す対象となる連続した文字数を表す、呼び出し側が指定するカウントです。
pptqD	POINTQF*	inout	文字幅を (28.36, 28.36) 形式で受け取る、c 個分の POINTQF 構造体の配列への、呼び出し側が指定するポインターです。このデータ型の説明については、GDI Data Types を参照してください。

戻り値の型: BOOL

公式ドキュメント

STROBJ_bGetAdvanceWidths 関数は、指定された文字列を構成するグリフの推定幅を表すベクターの配列を取得します。

戻り値

操作が成功した場合、関数は TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

STROBJ_bGetAdvanceWidths 関数は、STROBJ_bEnum の代わりに STROBJ_bEnumPositionsOnly を呼び出すプリンタードライバーにとって有用です。この関数は pptqD 配列に文字列のグリフの推定幅を設定します。プリンターのグリフレンダリングハードウェアが正確な文字幅を返さない場合に、文字列がプリンターでレンダリングされた後のプリンター位置を計算するために使用できます。

なお、STROBJ_bEnumPositionsOnly が返すグリフ位置は、STROBJ_bGetAdvanceWidths が返す幅と必ずしも正確に一致するわけではありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_bGetAdvanceWidths(
    STROBJ* pso,
    DWORD iFirst,
    DWORD c,
    POINTQF* pptqD
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool STROBJ_bGetAdvanceWidths(
    IntPtr pso,   // STROBJ* in/out
    uint iFirst,   // DWORD
    uint c,   // DWORD
    IntPtr pptqD   // POINTQF* in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function STROBJ_bGetAdvanceWidths(
    pso As IntPtr,   ' STROBJ* in/out
    iFirst As UInteger,   ' DWORD
    c As UInteger,   ' DWORD
    pptqD As IntPtr   ' POINTQF* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pso : STROBJ* in/out
' iFirst : DWORD
' c : DWORD
' pptqD : POINTQF* in/out
Declare PtrSafe Function STROBJ_bGetAdvanceWidths Lib "gdi32" ( _
    ByVal pso As LongPtr, _
    ByVal iFirst As Long, _
    ByVal c As Long, _
    ByVal pptqD As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

STROBJ_bGetAdvanceWidths = ctypes.windll.gdi32.STROBJ_bGetAdvanceWidths
STROBJ_bGetAdvanceWidths.restype = wintypes.BOOL
STROBJ_bGetAdvanceWidths.argtypes = [
    ctypes.c_void_p,  # pso : STROBJ* in/out
    wintypes.DWORD,  # iFirst : DWORD
    wintypes.DWORD,  # c : DWORD
    ctypes.c_void_p,  # pptqD : POINTQF* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
STROBJ_bGetAdvanceWidths = Fiddle::Function.new(
  lib['STROBJ_bGetAdvanceWidths'],
  [
    Fiddle::TYPE_VOIDP,  # pso : STROBJ* in/out
    -Fiddle::TYPE_INT,  # iFirst : DWORD
    -Fiddle::TYPE_INT,  # c : DWORD
    Fiddle::TYPE_VOIDP,  # pptqD : POINTQF* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn STROBJ_bGetAdvanceWidths(
        pso: *mut STROBJ,  // STROBJ* in/out
        iFirst: u32,  // DWORD
        c: u32,  // DWORD
        pptqD: *mut POINTQF  // POINTQF* 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_bGetAdvanceWidths(IntPtr pso, uint iFirst, uint c, IntPtr pptqD);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_STROBJ_bGetAdvanceWidths' -Namespace Win32 -PassThru
# $api::STROBJ_bGetAdvanceWidths(pso, iFirst, c, pptqD)

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

出力引数:

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