ScriptGetCMap

関数

文字に対応するフォントのグリフインデックスを取得する。

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

シグネチャ

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

HRESULT ScriptGetCMap(
    HDC hdc,
    void** psc,
    LPCWSTR pwcInChars,
    INT cChars,
    DWORD dwFlags,
    WORD* pwOutGlyphs
);

パラメーター

名前

型

方向

説明

hdc

HDC

省略可能。デバイスコンテキストへのハンドルです。詳細については、Caching を参照してください。

psc

void**

inout

スクリプトキャッシュを識別する SCRIPT_CACHE 構造体へのポインターです。

pwcInChars

LPCWSTR

Unicode 文字の文字列へのポインターです。

cChars

INT

pwcInChars で示される文字列内の Unicode 文字数です。

dwFlags

DWORD

グリフの特別な処理を指定するフラグです。既定では、グリフは特別な処理を行わずに論理順序で提供されます。このパラメーターには次の値を指定できます。

値	意味
SGCM_RTL	pwOutGlyphs で示されるグリフ配列には、ミラー化された等価物を持つグリフについて、ミラー化されたグリフが含まれるようにします。

pwOutGlyphs

WORD*

out

関数がグリフインデックスの配列を取得するバッファーへのポインターです。このバッファーは、pwcInChars で示される入力バッファーと同じ長さである必要があります。各コードポイントは単一のグリフにマップされます。

戻り値の型: HRESULT

公式ドキュメント

文字列内の Unicode 文字のグリフインデックスを、TrueType cmap テーブル、または旧形式フォント向けに実装された標準 cmap テーブルのいずれかに従って取得します。

戻り値

すべての Unicode コードポイントがフォントに存在する場合は S_OK を返します。成功しなかった場合、関数は以下に示す 0 以外の HRESULT 値のいずれかを返します。

戻り値	意味
E_HANDLE	フォントまたはオペレーティングシステムがグリフインデックスをサポートしていません。
S_FALSE	一部の Unicode コードポイントが既定のグリフにマップされました。

解説(Remarks)

この関数が通常呼び出されるコンテキストについては、Displaying Text with Uniscribe を参照してください。

この関数は、ラン内のどの文字が選択されたフォントでサポートされているかを判別するために使用できます。アプリケーションは、取得したグリフバッファーをスキャンし、既定のグリフを探すことで、利用できない文字を判別できます。アプリケーションは、ScriptGetFontProperties を呼び出して、選択されたフォントの既定のグリフインデックスを判別する必要があります。

この関数の戻り値は、欠落しているグリフの有無を示します。

Note この関数は、入力配列と出力配列の要素間に 1:1 の関係があると想定します。ただし、UTF-16 サロゲートペアについてはこの関係をサポートしません。サロゲートペアの場合、関数は補助平面文字のグリフインデックスを取得しません。同様に、この関数は Unicode の異体字セレクター(VS)シーケンスをサポートしません。これは、Unicode の図形文字に続いて、その図形文字に対する特定のグリフ表現を選択する一連の VARIATION SELECTOR 文字のいずれか 1 つで構成されます。VS シーケンスの場合、関数は VS シーケンスに対する特定のグリフのグリフインデックスではなく、2 つの文字に対して cmap によってマップされた既定のグリフのグリフインデックスを取得します。

一部のコードポイントは、単一のグリフだけでなく、複数のグリフの組み合わせによってもレンダリングできます。たとえば、00C9; LATIN CAPITAL LETTER E WITH ACUTE です。この場合、フォントが大文字 E のグリフとアキュートのグリフはサポートしているが、00C9 用の単一グリフはサポートしていないとき、ScriptGetCMap は 00C9 がサポートされていないことを示します。この種のコードポイントを含む文字列に対するフォントのサポート状況を判別するには、アプリケーションは ScriptShape を呼び出すことができます。関数が S_OK を返した場合、アプリケーションは欠落しているグリフがないか出力を確認する必要があります。

Important Windows 8 以降: Windows 7 上で実行する能力を維持するには、Uniscribe を使用するモジュールは、ライブラリ一覧で gdi32.lib より前に Usp10.lib を指定する必要があります。

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

各言語での呼び出し定義

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

HRESULT ScriptGetCMap(
    HDC hdc,
    void** psc,
    LPCWSTR pwcInChars,
    INT cChars,
    DWORD dwFlags,
    WORD* pwOutGlyphs
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptGetCMap(
    IntPtr hdc,   // HDC
    IntPtr psc,   // void** in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pwcInChars,   // LPCWSTR
    int cChars,   // INT
    uint dwFlags,   // DWORD
    out ushort pwOutGlyphs   // WORD* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptGetCMap(
    hdc As IntPtr,   ' HDC
    psc As IntPtr,   ' void** in/out
    <MarshalAs(UnmanagedType.LPWStr)> pwcInChars As String,   ' LPCWSTR
    cChars As Integer,   ' INT
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef pwOutGlyphs As UShort   ' WORD* out
) As Integer
End Function

' hdc : HDC
' psc : void** in/out
' pwcInChars : LPCWSTR
' cChars : INT
' dwFlags : DWORD
' pwOutGlyphs : WORD* out
Declare PtrSafe Function ScriptGetCMap Lib "usp10" ( _
    ByVal hdc As LongPtr, _
    ByVal psc As LongPtr, _
    ByVal pwcInChars As LongPtr, _
    ByVal cChars As Long, _
    ByVal dwFlags As Long, _
    ByRef pwOutGlyphs As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptGetCMap = ctypes.windll.usp10.ScriptGetCMap
ScriptGetCMap.restype = ctypes.c_int
ScriptGetCMap.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # psc : void** in/out
    wintypes.LPCWSTR,  # pwcInChars : LPCWSTR
    ctypes.c_int,  # cChars : INT
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # pwOutGlyphs : WORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptGetCMap = Fiddle::Function.new(
  lib['ScriptGetCMap'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # psc : void** in/out
    Fiddle::TYPE_VOIDP,  # pwcInChars : LPCWSTR
    Fiddle::TYPE_INT,  # cChars : INT
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pwOutGlyphs : WORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptGetCMap(
        hdc: *mut core::ffi::c_void,  // HDC
        psc: *mut *mut (),  // void** in/out
        pwcInChars: *const u16,  // LPCWSTR
        cChars: i32,  // INT
        dwFlags: u32,  // DWORD
        pwOutGlyphs: *mut u16  // WORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptGetCMap(IntPtr hdc, IntPtr psc, [MarshalAs(UnmanagedType.LPWStr)] string pwcInChars, int cChars, uint dwFlags, out ushort pwOutGlyphs);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptGetCMap' -Namespace Win32 -PassThru
# $api::ScriptGetCMap(hdc, psc, pwcInChars, cChars, dwFlags, pwOutGlyphs)

#uselib "USP10.dll"
#func global ScriptGetCMap "ScriptGetCMap" sptr, sptr, sptr, sptr, sptr, sptr
; ScriptGetCMap hdc, psc, pwcInChars, cChars, dwFlags, varptr(pwOutGlyphs)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; psc : void** in/out -> "sptr"
; pwcInChars : LPCWSTR -> "sptr"
; cChars : INT -> "sptr"
; dwFlags : DWORD -> "sptr"
; pwOutGlyphs : WORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptGetCMap "ScriptGetCMap" sptr, sptr, wstr, int, int, var
; res = ScriptGetCMap(hdc, psc, pwcInChars, cChars, dwFlags, pwOutGlyphs)
; hdc : HDC -> "sptr"
; psc : void** in/out -> "sptr"
; pwcInChars : LPCWSTR -> "wstr"
; cChars : INT -> "int"
; dwFlags : DWORD -> "int"
; pwOutGlyphs : WORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptGetCMap "ScriptGetCMap" sptr, sptr, wstr, int, int, sptr
; res = ScriptGetCMap(hdc, psc, pwcInChars, cChars, dwFlags, varptr(pwOutGlyphs))
; hdc : HDC -> "sptr"
; psc : void** in/out -> "sptr"
; pwcInChars : LPCWSTR -> "wstr"
; cChars : INT -> "int"
; dwFlags : DWORD -> "int"
; pwOutGlyphs : WORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。