ホーム › Globalization › ScriptRecordDigitSubstitution

ScriptRecordDigitSubstitution

関数

ロケールの数字置換設定を取得して記録する。

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

シグネチャ

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

HRESULT ScriptRecordDigitSubstitution(
    DWORD Locale,
    SCRIPT_DIGITSUBSTITUTE* psds
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	問い合わせ対象ロケールのロケール識別子。通常、アプリケーションはこのパラメーターに LOCALE_USER_DEFAULT を設定します。あるいは、特定のロケールを LOCALE_NOUSEROVERRIDE と組み合わせて指定し、既定の設定を取得することもできます。
psds	SCRIPT_DIGITSUBSTITUTE*	out	SCRIPT_DIGITSUBSTITUTE 構造体へのポインター。この構造体は、後で ScriptApplyDigitSubstitution に渡すことができます。

戻り値の型: HRESULT

公式ドキュメント

National Language Support (NLS) のネイティブ数字および数字置換の設定を読み取り、SCRIPT_DIGITSUBSTITUTE 構造体に記録します。詳細については、「Digit Shapes」を参照してください。

戻り値

成功した場合は S_OK を返します。成功しなかった場合、関数は 0 以外の HRESULT 値を返します。

エラーの戻り値には次のものが含まれます。

E_INVALIDARG。Locale パラメーターが無効、またはインストールされていないロケールを示しています。
E_POINTER。psds パラメーターが NULL に設定されています。

解説(Remarks)

この関数が通常呼び出される文脈については、「Displaying Text with Uniscribe」を参照してください。

この関数は、アラビア語およびペルシャ語のロケールについてのみコンテキスト数字置換をサポートします。その他のロケールでは、コンテキスト数字置換は置換なしにマッピングされます。

次の例は、この関数を呼び出す一般的な方法を示しています。

SCRIPT_DIGITSUBSTITUTE sds;
ScriptRecordDigitSubstitution(LOCALE_USER_DEFAULT, &sds);

各項目化 (itemization) の際に、アプリケーションは次の例に示すように結果を使用できます。

SCRIPT_CONTROL sc = {0};
SCRIPT_STATE   ss = {0};
ScriptApplyDigitSubstitution(&sds, &sc, &ss);

パフォーマンス上の理由から、アプリケーションは ScriptRecordDigitSubstitution を頻繁に呼び出すべきではありません。ScriptItemize または ScriptStringAnalyse を呼び出すたびにこの関数を呼び出すと、相当なオーバーヘッドが発生します。代わりに、アプリケーションは SCRIPT_DIGITSUBSTITUTE 構造体を保存しておき、WM_SETTINGCHANGE メッセージを受信したときにのみ更新できます。あるいは、専用スレッド内の RegNotifyChangeKeyValue 呼び出しが HKCU\Control Panel\International 配下のレジストリの変更を示したときに、構造体を更新することもできます。

重要 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 ScriptRecordDigitSubstitution(
    DWORD Locale,
    SCRIPT_DIGITSUBSTITUTE* psds
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptRecordDigitSubstitution(
    uint Locale,   // DWORD
    IntPtr psds   // SCRIPT_DIGITSUBSTITUTE* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptRecordDigitSubstitution(
    Locale As UInteger,   ' DWORD
    psds As IntPtr   ' SCRIPT_DIGITSUBSTITUTE* out
) As Integer
End Function

' Locale : DWORD
' psds : SCRIPT_DIGITSUBSTITUTE* out
Declare PtrSafe Function ScriptRecordDigitSubstitution Lib "usp10" ( _
    ByVal Locale As Long, _
    ByVal psds As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptRecordDigitSubstitution = ctypes.windll.usp10.ScriptRecordDigitSubstitution
ScriptRecordDigitSubstitution.restype = ctypes.c_int
ScriptRecordDigitSubstitution.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    ctypes.c_void_p,  # psds : SCRIPT_DIGITSUBSTITUTE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptRecordDigitSubstitution = Fiddle::Function.new(
  lib['ScriptRecordDigitSubstitution'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    Fiddle::TYPE_VOIDP,  # psds : SCRIPT_DIGITSUBSTITUTE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptRecordDigitSubstitution(
        Locale: u32,  // DWORD
        psds: *mut SCRIPT_DIGITSUBSTITUTE  // SCRIPT_DIGITSUBSTITUTE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptRecordDigitSubstitution(uint Locale, IntPtr psds);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptRecordDigitSubstitution' -Namespace Win32 -PassThru
# $api::ScriptRecordDigitSubstitution(Locale, psds)

#uselib "USP10.dll"
#func global ScriptRecordDigitSubstitution "ScriptRecordDigitSubstitution" sptr, sptr
; ScriptRecordDigitSubstitution Locale, varptr(psds)   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; psds : SCRIPT_DIGITSUBSTITUTE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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