GetGlyphIndicesA

関数

文字列をグリフインデックスに変換して取得する。

DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetGlyphIndicesA(
    HDC hdc,
    LPCSTR lpstr,
    INT c,
    WORD* pgi,
    DWORD fl
);

パラメーター

名前

型

方向

説明

hdc

HDC

デバイスコンテキストへのハンドルです。

lpstr

LPCSTR

変換する文字列へのポインターです。

INT

lpstr が指す文字列の長さと、pgi が指すバッファーのサイズ(WORD 単位)の両方を指定します。

pgi

WORD*

out

このバッファーは次元 c を持つ必要があります。正常に返ると、文字列内の文字に対応するグリフインデックスの配列が格納されます。

DWORD

サポートされていないグリフをどのように処理するかを指定します。このパラメーターには次の値を指定できます。

値	意味
GGI_MARK_NONEXISTING_GLYPHS	サポートされていないグリフを 16 進値 0xffff でマークします。

戻り値の型: DWORD

公式ドキュメント

GetGlyphIndices 関数は、文字列をグリフインデックスの配列に変換します。この関数は、グリフがフォント内に存在するかどうかを判定するために使用できます。(ANSI)

戻り値

関数が成功した場合、変換されたバイト数(ANSI 関数の場合)または WORD 数(Unicode 関数の場合)を返します。

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

解説(Remarks)

この関数は、lpstr が指す文字列内の各文字について、単一グリフによる表現を特定しようとします。これはフォントファイルの操作などの特定の低レベルな目的には有用ですが、文字列をグリフにマップしたい高レベルなアプリケーションでは、通常は Uniscribe 関数を使用するのが望ましいでしょう。

メモ

wingdi.h ヘッダーは、GetGlyphIndices を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーやランタイムエラーを引き起こす不整合につながる可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetGlyphIndicesA(
    HDC hdc,
    LPCSTR lpstr,
    INT c,
    WORD* pgi,
    DWORD fl
);

[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetGlyphIndicesA(
    IntPtr hdc,   // HDC
    [MarshalAs(UnmanagedType.LPStr)] string lpstr,   // LPCSTR
    int c,   // INT
    out ushort pgi,   // WORD* out
    uint fl   // DWORD
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetGlyphIndicesA(
    hdc As IntPtr,   ' HDC
    <MarshalAs(UnmanagedType.LPStr)> lpstr As String,   ' LPCSTR
    c As Integer,   ' INT
    <Out> ByRef pgi As UShort,   ' WORD* out
    fl As UInteger   ' DWORD
) As UInteger
End Function

' hdc : HDC
' lpstr : LPCSTR
' c : INT
' pgi : WORD* out
' fl : DWORD
Declare PtrSafe Function GetGlyphIndicesA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpstr As String, _
    ByVal c As Long, _
    ByRef pgi As Integer, _
    ByVal fl As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetGlyphIndicesA = ctypes.windll.gdi32.GetGlyphIndicesA
GetGlyphIndicesA.restype = wintypes.DWORD
GetGlyphIndicesA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCSTR,  # lpstr : LPCSTR
    ctypes.c_int,  # c : INT
    ctypes.POINTER(ctypes.c_ushort),  # pgi : WORD* out
    wintypes.DWORD,  # fl : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetGlyphIndicesA = Fiddle::Function.new(
  lib['GetGlyphIndicesA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpstr : LPCSTR
    Fiddle::TYPE_INT,  # c : INT
    Fiddle::TYPE_VOIDP,  # pgi : WORD* out
    -Fiddle::TYPE_INT,  # fl : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetGlyphIndicesA(
        hdc: *mut core::ffi::c_void,  // HDC
        lpstr: *const u8,  // LPCSTR
        c: i32,  // INT
        pgi: *mut u16,  // WORD* out
        fl: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetGlyphIndicesA(IntPtr hdc, [MarshalAs(UnmanagedType.LPStr)] string lpstr, int c, out ushort pgi, uint fl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetGlyphIndicesA' -Namespace Win32 -PassThru
# $api::GetGlyphIndicesA(hdc, lpstr, c, pgi, fl)

#uselib "GDI32.dll"
#func global GetGlyphIndicesA "GetGlyphIndicesA" sptr, sptr, sptr, sptr, sptr
; GetGlyphIndicesA hdc, lpstr, c, varptr(pgi), fl   ; 戻り値は stat
; hdc : HDC -> "sptr"
; lpstr : LPCSTR -> "sptr"
; c : INT -> "sptr"
; pgi : WORD* out -> "sptr"
; fl : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetGlyphIndicesA "GetGlyphIndicesA" sptr, str, int, var, int
; res = GetGlyphIndicesA(hdc, lpstr, c, pgi, fl)
; hdc : HDC -> "sptr"
; lpstr : LPCSTR -> "str"
; c : INT -> "int"
; pgi : WORD* out -> "var"
; fl : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetGlyphIndicesA "GetGlyphIndicesA" sptr, str, int, sptr, int
; res = GetGlyphIndicesA(hdc, lpstr, c, varptr(pgi), fl)
; hdc : HDC -> "sptr"
; lpstr : LPCSTR -> "str"
; c : INT -> "int"
; pgi : WORD* out -> "sptr"
; fl : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。