Win32 API 日本語リファレンス
ホームGraphics.Gdi › GetCharacterPlacementA

GetCharacterPlacementA

関数
文字列の表示用配置情報を取得する。
DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetCharacterPlacementA(
    HDC hdc,
    LPCSTR lpString,
    INT nCount,
    INT nMexExtent,
    GCP_RESULTSA* lpResults,
    GET_CHARACTER_PLACEMENT_FLAGS dwFlags
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
lpStringLPCSTRin処理対象の文字列へのポインター。nCount が文字列の長さを指定するため、文字列はゼロ終端されている必要はありません。
nCountINTinlpString が指す文字列の長さ
nMexExtentINTin文字列を処理する最大範囲(論理単位)。処理するとこの範囲を超える文字は無視されます。必要な並び順配列やグリフ配列の計算は、含まれる文字に対してのみ適用されます。このパラメーターは、dwFlags パラメーターに GCP_MAXEXTENT 値が指定されている場合にのみ使用されます。この関数は入力文字列を処理する際、合計範囲がまだ最大値を超えていない場合にのみ、各文字とその範囲を出力配列、範囲配列、その他の配列に追加します。上限に達すると処理は停止します。
lpResultsGCP_RESULTSA*inout関数の結果を受け取る GCP_RESULTS 構造体へのポインター。
dwFlagsGET_CHARACTER_PLACEMENT_FLAGSin

文字列を必要な配列に処理する方法を指定します。このパラメーターには、次の値を 1 つ以上指定できます。

意味
GCP_CLASSIN
lpClass 配列に文字のあらかじめ設定された分類が含まれていることを指定します。分類は出力時と同じである場合があります。特定の文字の分類が不明な場合は、配列内の対応する位置をゼロに設定する必要があります。分類の詳細については、GCP_RESULTS を参照してください。これは GetFontLanguageInfoGCP_REORDER フラグを返した場合にのみ有用です。
GCP_DIACRITIC
文字列内のダイアクリティカルマークの扱い方を決定します。この値が設定されていない場合、ダイアクリティカルマークは幅ゼロの文字として扱われます。たとえば、ヘブライ語の文字列にはダイアクリティカルマークが含まれることがありますが、それらを表示したくない場合があります。

フォントがダイアクリティカルマークをサポートしているかどうかを判定するには、GetFontLanguageInfo を使用します。サポートしている場合は、アプリケーションの必要に応じて、GetCharacterPlacement の呼び出しで GCP_DIACRITIC フラグを使用するかどうかを選択できます。

GCP_DISPLAYZWG
単語内の文字位置に応じて並べ替えや異なるグリフ形状が必要な言語では、表示されない文字がコードページに含まれることがよくあります。たとえば、ヘブライ語のコードページには、出力文字列内での文字の最終的な配置を決定するのに役立つ左から右(Left-To-Right)マーカーと右から左(Right-To-Left)マーカーがあります。通常これらは表示されず、lpGlyphs 配列および lpDx 配列から削除されます。GCP_DISPLAYZWG フラグを使用すると、これらの文字を表示できます。
GCP_GLYPHSHAPE
文字列内の一部またはすべての文字を、現在のコードページ用に現在選択されているフォントで定義された標準形状以外の形状で表示することを指定します。アラビア語などの一部の言語では、この値を指定しないとグリフ生成をサポートできません。一般的な規則として、GetFontLanguageInfo が文字列に対してこの値を返す場合は、GetCharacterPlacement でこの値を使用する必要があります。
GCP_JUSTIFY
文字列の長さが nMaxExtent と等しくなるように、lpDx 配列内の範囲を調整します。GCP_JUSTIFYGCP_MAXEXTENT と組み合わせた場合にのみ使用できます。
GCP_KASHIDA
文字列の長さを nMaxExtent で指定された値と等しくするために、調整された範囲とともに、またはその代わりにカシーダ(Kashida)を使用します。lpDx 配列では、カシーダは負の両端揃えインデックスで示されます。GCP_KASHIDAGCP_JUSTIFY と組み合わせた場合にのみ、かつフォント(および言語)がカシーダをサポートしている場合にのみ使用できます。現在のフォントがカシーダをサポートしているかどうかを判定するには、GetFontLanguageInfo を使用します。

カシーダを使用して文字列を両端揃えにすると、必要なグリフ数が入力文字列の文字数を超える場合があります。このため、カシーダを使用する場合、アプリケーションは配列を入力文字列のサイズに設定するだけで十分であると想定できません。(最大値はおおよそ dxPageWidth/dxAveCharWidth になります。ここで dxPageWidth はドキュメントの幅、dxAveCharWidth は GetTextMetrics 呼び出しから返される平均文字幅です。)

GetFontLanguageInfoGCP_KASHIDA フラグを返すからといって、GetCharacterPlacement の呼び出しで必ずそれを使用しなければならないわけではなく、そのオプションが利用可能であることを意味するだけである点に注意してください。

GCP_LIGATE
文字が合字になる箇所では合字を使用します。合字とは、2 つ以上の文字に対して 1 つのグリフが使用される状態を指します。たとえば、文字 a と e は ? に合字化できます。ただし、これを使用するには、言語サポートとフォントの両方が必要なグリフをサポートしている必要があります(この例は英語では既定では処理されません)。

現在のフォントが合字をサポートしているかどうかを判定するには、GetFontLanguageInfo を使用します。サポートしており、合字化する文字数に特定の最大値が必要な場合は、その数を lpGlyphs 配列の最初の要素に設定します。通常の合字が必要な場合は、この値をゼロに設定します。GCP_LIGATE が指定されていない場合、合字は行われません。詳細については GCP_RESULTS を参照してください。

文字セットに対して通常 GCP_REORDER 値が必要であるにもかかわらず指定されていない場合、渡される文字列がすでに視覚的な並び順になっている場合を除き(つまり、GetCharacterPlacement の 1 回目の呼び出しで lpGcpResults->lpOutString に格納される結果が 2 回目の呼び出しの入力文字列となる場合)、出力は意味をなしません。

GetFontLanguageInfoGCP_LIGATE フラグを返すからといって、GetCharacterPlacement の呼び出しで必ずそれを使用しなければならないわけではなく、そのオプションが利用可能であることを意味するだけである点に注意してください。

GCP_MAXEXTENT
結果として得られる範囲(論理単位)が nMaxExtent パラメーターで指定された値を超えない範囲でのみ、文字列の範囲を計算します。
GCP_NEUTRALOVERRIDE
特定の言語のみ。中立文字の通常の処理を上書きし、文字列の読み取り順序に一致する強い文字として扱います。GCP_REORDER フラグと組み合わせた場合にのみ有用です。
GCP_NUMERICOVERRIDE
特定の言語のみ。数字の通常の処理を上書きし、文字列の読み取り順序に一致する強い文字として扱います。GCP_REORDER フラグと組み合わせた場合にのみ有用です。
GCP_NUMERICSLATIN
アラビア語/タイ語のみ。数字に標準のラテングリフを使用し、システムの既定を上書きします。このオプションがフォントの言語で利用可能かどうかを判定するには、GetStringTypeEx を使用して、その言語が複数の数字形式をサポートしているかどうかを確認します。
GCP_NUMERICSLOCAL
アラビア語/タイ語のみ。数字にローカルのグリフを使用し、システムの既定を上書きします。このオプションがフォントの言語で利用可能かどうかを判定するには、GetStringTypeEx を使用して、その言語が複数の数字形式をサポートしているかどうかを確認します。
GCP_REORDER
文字列を並べ替えます。SBCS および左から右への読み取り順序ではない言語に使用します。この値が指定されていない場合、文字列はすでに表示順序になっていると見なされます。

セム系言語に対してこのフラグが設定されており、lpClass 配列が使用されている場合、配列の最初の 2 つの要素は文字列の範囲を超えた読み取り順序を指定するために使用されます。GCP_CLASS_PREBOUNDRTL および GCP_CLASS_PREBOUNDLTR を使用して順序を設定できます。あらかじめ設定する順序が不要な場合は、値をゼロに設定します。これらの値は、GCPCLASSIN フラグが設定されている場合に他の値と組み合わせることができます。

GCP_REORDER 値が指定されていない場合、lpString パラメーターは、これが使用される言語では視覚的な並び順であると見なされ、lpOutString および lpOrder フィールドは無視されます。

現在のフォントが並べ替えをサポートしているかどうかを判定するには、GetFontLanguageInfo を使用します。

GCP_SYMSWAPOFF
セム系言語のみ。入れ替え可能な文字をリセットしないことを指定します。たとえば、右から左への文字列では、'(' と ')' は反転されません。
GCP_USEKERNING
幅配列を作成する際に、フォント内のカーニングペア(存在する場合)を使用します。現在のフォントがカーニングペアをサポートしているかどうかを判定するには、GetFontLanguageInfo を使用します。

GetFontLanguageInfoGCP_USEKERNING フラグを返すからといって、GetCharacterPlacement の呼び出しで必ずそれを使用しなければならないわけではなく、そのオプションが利用可能であることを意味するだけである点に注意してください。ほとんどの TrueType フォントにはカーニングテーブルがありますが、それを使用する必要はありません。

アプリケーションでは、GetFontLanguageInfo 関数を使用して、GCP_DIACRITICGCP_DBCSGCP_USEKERNINGGCP_LIGATEGCP_REORDERGCP_GLYPHSHAPEGCP_KASHIDA の各値が現在選択されているフォントに対して有効かどうかを判定することをお勧めします。有効でない場合、GetCharacterPlacement はその値を無視します。

GCP_NODIACRITICS 値はもはや定義されておらず、使用しないでください。

戻り値の型: DWORD

公式ドキュメント

GetCharacterPlacement 関数は、文字列に関する情報(文字幅、キャレット位置、文字列内での並び順、グリフのレンダリングなど)を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は文字列の幅と高さ(論理単位)です。幅が下位ワード、高さが上位ワードになります。

関数が失敗した場合、戻り値はゼロです。

解説(Remarks)

GetCharacterPlacement は、国際設定や利用可能なフォントの種類に関係なく、アプリケーションがテキストを正しく処理できるようにします。アプリケーションでは、ExtTextOut 関数を使用する前に、また GetTextExtentPoint32 関数の代わりに(そして場合によっては GetCharWidth32 関数や GetCharABCWidths 関数の代わりに)この関数を使用します。

両端揃えやカーニングが必要でない限り、文字間隔やインデックス配列を取得するために GetCharacterPlacement を使用することは必ずしも必要ではありません。非ラテン系フォントの場合、アプリケーションは ExtTextOut を呼び出す前に GetCharacterPlacement を使用して文字間隔とインデックス配列を取得することで、ExtTextOut 関数がテキストをレンダリングする速度を向上できます。これは、同じテキストを繰り返しレンダリングする場合や、文字間隔を使用してキャレットを配置する場合に特に有用です。ExtTextOut の呼び出しで lpGlyphs 出力配列を使用する場合は、ETO_GLYPH_INDEX フラグを設定する必要があります。

GetCharacterPlacement は、GCP_RESULTS 構造体の lpOrderlpDXlpCaretPoslpOutStringlpGlyphs の各メンバーを確認し、これらのメンバーが NULL に設定されていない場合は対応する配列を埋めます。GetCharacterPlacement が配列を埋められない場合は、対応するメンバーを NULL に設定します。有効な情報の取得を保証するには、関数を呼び出す前にメンバーを有効なアドレスに設定し、呼び出し後にメンバーの値を確認する責任がアプリケーションにあります。GCP_JUSTIFY 値または GCP_USEKERNING 値が指定されている場合、lpDX および/または lpCaretPos メンバーには有効なアドレスが設定されている必要があります。

GCP_RESULTS.lpGlyphs で返されるグリフインデックスは、デバイスコンテキスト内の現在のフォントに固有であり、そのフォントが選択されている間にデバイスコンテキスト内でテキストを描画する場合にのみ使用すべきである点に注意してください。

両端揃えを計算する際、文字列の末尾の文字がスペースである場合、関数は両端揃えを計算する前に文字列の長さを短くしてスペースを削除します。配列がスペースのみで構成されている場合、関数はエラーを返します。

ExtTextOut は DBCS 文字列の各バイトに対して lpDX エントリを必要としますが、GetCharacterPlacement は各グリフに対して lpDX エントリを割り当てます。これらの関数を組み合わせて使用する際にこの不一致を修正するには、GetGlyphIndices を使用するか、DBCS バイトペアの 2 番目のバイトに対応する幅ゼロのエントリで lpDX 配列を拡張します。

論理幅が入力文字列の先頭文字の幅より小さい場合、GCP_RESULTS.nMaxFit は不正な値を返します。この場合は、グリフインデックスと lpDX 配列を取得するために GetCharacterPlacement を呼び出します。次に、lpDX 配列を使用して各文字の送り幅で範囲計算を行います。このとき nMaxFit は、グリフインデックスの送り幅が先頭文字の幅より小さい文字の数です。

メモ

wingdi.h ヘッダーは、GetCharacterPlacement を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// GDI32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetCharacterPlacementA(
    HDC hdc,
    LPCSTR lpString,
    INT nCount,
    INT nMexExtent,
    GCP_RESULTSA* lpResults,
    GET_CHARACTER_PLACEMENT_FLAGS dwFlags
);
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetCharacterPlacementA(
    IntPtr hdc,   // HDC
    [MarshalAs(UnmanagedType.LPStr)] string lpString,   // LPCSTR
    int nCount,   // INT
    int nMexExtent,   // INT
    IntPtr lpResults,   // GCP_RESULTSA* in/out
    uint dwFlags   // GET_CHARACTER_PLACEMENT_FLAGS
);
<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetCharacterPlacementA(
    hdc As IntPtr,   ' HDC
    <MarshalAs(UnmanagedType.LPStr)> lpString As String,   ' LPCSTR
    nCount As Integer,   ' INT
    nMexExtent As Integer,   ' INT
    lpResults As IntPtr,   ' GCP_RESULTSA* in/out
    dwFlags As UInteger   ' GET_CHARACTER_PLACEMENT_FLAGS
) As UInteger
End Function
' hdc : HDC
' lpString : LPCSTR
' nCount : INT
' nMexExtent : INT
' lpResults : GCP_RESULTSA* in/out
' dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
Declare PtrSafe Function GetCharacterPlacementA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpString As String, _
    ByVal nCount As Long, _
    ByVal nMexExtent As Long, _
    ByVal lpResults As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetCharacterPlacementA = ctypes.windll.gdi32.GetCharacterPlacementA
GetCharacterPlacementA.restype = wintypes.DWORD
GetCharacterPlacementA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCSTR,  # lpString : LPCSTR
    ctypes.c_int,  # nCount : INT
    ctypes.c_int,  # nMexExtent : INT
    ctypes.c_void_p,  # lpResults : GCP_RESULTSA* in/out
    wintypes.DWORD,  # dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetCharacterPlacementA = Fiddle::Function.new(
  lib['GetCharacterPlacementA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpString : LPCSTR
    Fiddle::TYPE_INT,  # nCount : INT
    Fiddle::TYPE_INT,  # nMexExtent : INT
    Fiddle::TYPE_VOIDP,  # lpResults : GCP_RESULTSA* in/out
    -Fiddle::TYPE_INT,  # dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
  ],
  -Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn GetCharacterPlacementA(
        hdc: *mut core::ffi::c_void,  // HDC
        lpString: *const u8,  // LPCSTR
        nCount: i32,  // INT
        nMexExtent: i32,  // INT
        lpResults: *mut GCP_RESULTSA,  // GCP_RESULTSA* in/out
        dwFlags: u32  // GET_CHARACTER_PLACEMENT_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetCharacterPlacementA(IntPtr hdc, [MarshalAs(UnmanagedType.LPStr)] string lpString, int nCount, int nMexExtent, IntPtr lpResults, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetCharacterPlacementA' -Namespace Win32 -PassThru
# $api::GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
#uselib "GDI32.dll"
#func global GetCharacterPlacementA "GetCharacterPlacementA" sptr, sptr, sptr, sptr, sptr, sptr
; GetCharacterPlacementA hdc, lpString, nCount, nMexExtent, varptr(lpResults), dwFlags   ; 戻り値は stat
; hdc : HDC -> "sptr"
; lpString : LPCSTR -> "sptr"
; nCount : INT -> "sptr"
; nMexExtent : INT -> "sptr"
; lpResults : GCP_RESULTSA* in/out -> "sptr"
; dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global GetCharacterPlacementA "GetCharacterPlacementA" sptr, str, int, int, var, int
; res = GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
; hdc : HDC -> "sptr"
; lpString : LPCSTR -> "str"
; nCount : INT -> "int"
; nMexExtent : INT -> "int"
; lpResults : GCP_RESULTSA* in/out -> "var"
; dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetCharacterPlacementA(HDC hdc, LPCSTR lpString, INT nCount, INT nMexExtent, GCP_RESULTSA* lpResults, GET_CHARACTER_PLACEMENT_FLAGS dwFlags)
#uselib "GDI32.dll"
#cfunc global GetCharacterPlacementA "GetCharacterPlacementA" intptr, str, int, int, var, int
; res = GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
; hdc : HDC -> "intptr"
; lpString : LPCSTR -> "str"
; nCount : INT -> "int"
; nMexExtent : INT -> "int"
; lpResults : GCP_RESULTSA* in/out -> "var"
; dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetCharacterPlacementA = gdi32.NewProc("GetCharacterPlacementA")
)

// hdc (HDC), lpString (LPCSTR), nCount (INT), nMexExtent (INT), lpResults (GCP_RESULTSA* in/out), dwFlags (GET_CHARACTER_PLACEMENT_FLAGS)
r1, _, err := procGetCharacterPlacementA.Call(
	uintptr(hdc),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString))),
	uintptr(nCount),
	uintptr(nMexExtent),
	uintptr(lpResults),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetCharacterPlacementA(
  hdc: THandle;   // HDC
  lpString: PAnsiChar;   // LPCSTR
  nCount: Integer;   // INT
  nMexExtent: Integer;   // INT
  lpResults: Pointer;   // GCP_RESULTSA* in/out
  dwFlags: DWORD   // GET_CHARACTER_PLACEMENT_FLAGS
): DWORD; stdcall;
  external 'GDI32.dll' name 'GetCharacterPlacementA';
result := DllCall("GDI32\GetCharacterPlacementA"
    , "Ptr", hdc   ; HDC
    , "AStr", lpString   ; LPCSTR
    , "Int", nCount   ; INT
    , "Int", nMexExtent   ; INT
    , "Ptr", lpResults   ; GCP_RESULTSA* in/out
    , "UInt", dwFlags   ; GET_CHARACTER_PLACEMENT_FLAGS
    , "UInt")   ; return: DWORD
●GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags) = DLL("GDI32.dll", "dword GetCharacterPlacementA(void*, char*, int, int, void*, dword)")
# 呼び出し: GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
# hdc : HDC -> "void*"
# lpString : LPCSTR -> "char*"
# nCount : INT -> "int"
# nMexExtent : INT -> "int"
# lpResults : GCP_RESULTSA* in/out -> "void*"
# dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn GetCharacterPlacementA(
    hdc: ?*anyopaque, // HDC
    lpString: [*c]const u8, // LPCSTR
    nCount: i32, // INT
    nMexExtent: i32, // INT
    lpResults: [*c]GCP_RESULTSA, // GCP_RESULTSA* in/out
    dwFlags: u32 // GET_CHARACTER_PLACEMENT_FLAGS
) callconv(std.os.windows.WINAPI) u32;
proc GetCharacterPlacementA(
    hdc: pointer,  # HDC
    lpString: cstring,  # LPCSTR
    nCount: int32,  # INT
    nMexExtent: int32,  # INT
    lpResults: ptr GCP_RESULTSA,  # GCP_RESULTSA* in/out
    dwFlags: uint32  # GET_CHARACTER_PLACEMENT_FLAGS
): uint32 {.importc: "GetCharacterPlacementA", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
uint GetCharacterPlacementA(
    void* hdc,   // HDC
    const(char)* lpString,   // LPCSTR
    int nCount,   // INT
    int nMexExtent,   // INT
    GCP_RESULTSA* lpResults,   // GCP_RESULTSA* in/out
    uint dwFlags   // GET_CHARACTER_PLACEMENT_FLAGS
);
ccall((:GetCharacterPlacementA, "GDI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Int32, Int32, Ptr{GCP_RESULTSA}, UInt32),
      hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
# hdc : HDC -> Ptr{Cvoid}
# lpString : LPCSTR -> Cstring
# nCount : INT -> Int32
# nMexExtent : INT -> Int32
# lpResults : GCP_RESULTSA* in/out -> Ptr{GCP_RESULTSA}
# dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetCharacterPlacementA(
    void* hdc,
    const char* lpString,
    int32_t nCount,
    int32_t nMexExtent,
    void* lpResults,
    uint32_t dwFlags);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
-- hdc : HDC
-- lpString : LPCSTR
-- nCount : INT
-- nMexExtent : INT
-- lpResults : GCP_RESULTSA* in/out
-- dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetCharacterPlacementA = lib.func('__stdcall', 'GetCharacterPlacementA', 'uint32_t', ['void *', 'str', 'int32_t', 'int32_t', 'void *', 'uint32_t']);
// GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
// hdc : HDC -> 'void *'
// lpString : LPCSTR -> 'str'
// nCount : INT -> 'int32_t'
// nMexExtent : INT -> 'int32_t'
// lpResults : GCP_RESULTSA* in/out -> 'void *'
// dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetCharacterPlacementA: { parameters: ["pointer", "buffer", "i32", "i32", "pointer", "u32"], result: "u32" },
});
// lib.symbols.GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
// hdc : HDC -> "pointer"
// lpString : LPCSTR -> "buffer"
// nCount : INT -> "i32"
// nMexExtent : INT -> "i32"
// lpResults : GCP_RESULTSA* in/out -> "pointer"
// dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetCharacterPlacementA(
    void* hdc,
    const char* lpString,
    int32_t nCount,
    int32_t nMexExtent,
    void* lpResults,
    uint32_t dwFlags);
C, "GDI32.dll");
// $ffi->GetCharacterPlacementA(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags);
// hdc : HDC
// lpString : LPCSTR
// nCount : INT
// nMexExtent : INT
// lpResults : GCP_RESULTSA* in/out
// dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class, W32APIOptions.ASCII_OPTIONS);
    int GetCharacterPlacementA(
        Pointer hdc,   // HDC
        String lpString,   // LPCSTR
        int nCount,   // INT
        int nMexExtent,   // INT
        Pointer lpResults,   // GCP_RESULTSA* in/out
        int dwFlags   // GET_CHARACTER_PLACEMENT_FLAGS
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun GetCharacterPlacementA = GetCharacterPlacementA(
    hdc : Void*,   # HDC
    lpString : UInt8*,   # LPCSTR
    nCount : Int32,   # INT
    nMexExtent : Int32,   # INT
    lpResults : GCP_RESULTSA*,   # GCP_RESULTSA* in/out
    dwFlags : UInt32   # GET_CHARACTER_PLACEMENT_FLAGS
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetCharacterPlacementANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Int32, Int32, Pointer<Void>, Uint32);
typedef GetCharacterPlacementADart = int Function(Pointer<Void>, Pointer<Utf8>, int, int, Pointer<Void>, int);
final GetCharacterPlacementA = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetCharacterPlacementANative, GetCharacterPlacementADart>('GetCharacterPlacementA');
// hdc : HDC -> Pointer<Void>
// lpString : LPCSTR -> Pointer<Utf8>
// nCount : INT -> Int32
// nMexExtent : INT -> Int32
// lpResults : GCP_RESULTSA* in/out -> Pointer<Void>
// dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetCharacterPlacementA(
  hdc: THandle;   // HDC
  lpString: PAnsiChar;   // LPCSTR
  nCount: Integer;   // INT
  nMexExtent: Integer;   // INT
  lpResults: Pointer;   // GCP_RESULTSA* in/out
  dwFlags: DWORD   // GET_CHARACTER_PLACEMENT_FLAGS
): DWORD; stdcall;
  external 'GDI32.dll' name 'GetCharacterPlacementA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetCharacterPlacementA"
  c_GetCharacterPlacementA :: Ptr () -> CString -> Int32 -> Int32 -> Ptr () -> Word32 -> IO Word32
-- hdc : HDC -> Ptr ()
-- lpString : LPCSTR -> CString
-- nCount : INT -> Int32
-- nMexExtent : INT -> Int32
-- lpResults : GCP_RESULTSA* in/out -> Ptr ()
-- dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getcharacterplacementa =
  foreign "GetCharacterPlacementA"
    ((ptr void) @-> string @-> int32_t @-> int32_t @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* hdc : HDC -> (ptr void) *)
(* lpString : LPCSTR -> string *)
(* nCount : INT -> int32_t *)
(* nMexExtent : INT -> int32_t *)
(* lpResults : GCP_RESULTSA* in/out -> (ptr void) *)
(* dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("GetCharacterPlacementA" get-character-placement-a :convention :stdcall) :uint32
  (hdc :pointer)   ; HDC
  (lp-string :string)   ; LPCSTR
  (n-count :int32)   ; INT
  (n-mex-extent :int32)   ; INT
  (lp-results :pointer)   ; GCP_RESULTSA* in/out
  (dw-flags :uint32))   ; GET_CHARACTER_PLACEMENT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCharacterPlacementA = Win32::API::More->new('GDI32',
    'DWORD GetCharacterPlacementA(HANDLE hdc, LPCSTR lpString, int nCount, int nMexExtent, LPVOID lpResults, DWORD dwFlags)');
# my $ret = $GetCharacterPlacementA->Call($hdc, $lpString, $nCount, $nMexExtent, $lpResults, $dwFlags);
# hdc : HDC -> HANDLE
# lpString : LPCSTR -> LPCSTR
# nCount : INT -> int
# nMexExtent : INT -> int
# lpResults : GCP_RESULTSA* in/out -> LPVOID
# dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型