GetStringScripts

関数

文字列に含まれるスクリプトの一覧を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT GetStringScripts(
    DWORD dwFlags,
    LPCWSTR lpString,
    INT cchString,
    LPWSTR lpScripts,   // optional
    INT cchScripts
);

パラメーター

名前

型

方向

説明

dwFlags

DWORD

スクリプト取得のオプションを指定するフラグです。

値	意味
GSS_ALLOW_INHERITED_COMMON	"Qaii"(INHERITED)および "Zyyy"(COMMON)のスクリプト情報を取得します。このフラグは、未割り当て文字の処理には影響しません。入力文字列中のこれらの文字は、常にスクリプト文字列中に "Zzzz"(UNASSIGNED スクリプト)を出現させます。

注意既定では、GetStringScripts は lpString で示される入力文字列中の継承文字(inherited)や共通文字(common)をすべて無視します。GSS_ALLOW_INHERITED_COMMON が設定されていない場合、入力文字列にそのような文字が含まれていても、"Qaii" も "Zyyy" もスクリプト文字列には現れません。GSS_ALLOW_INHERITED_COMMON が設定されており、入力文字列に継承文字や共通文字が含まれている場合は、それぞれ "Qaii" や "Zyyy" がスクリプト文字列に現れます。「解説」セクションを参照してください。

lpString

LPCWSTR

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

cchString

INT

lpString で示される Unicode 文字列のサイズ(文字数)です。Unicode 文字列が null で終端されている場合、アプリケーションはこのパラメーターを -1 に設定します。このパラメーターを 0 に設定した場合、関数は lpScripts に null の Unicode 文字列(L"\0")を取得し、1 を返します。

lpScripts

LPWSTR

outoptional

スクリプトの一覧を表す null 終端文字列を、この関数が取得するバッファーへのポインターです。スクリプトは ISO 15924 で使用される 4 文字表記で表されます。各スクリプト名は 4 つのラテン文字から構成され、アルファベット順に取得されます。最後の名前を含む各名前の後にはセミコロンが続きます。

あるいは、cchScripts が 0 に設定されている場合、このパラメーターは NULL を格納します。この場合、関数はスクリプトバッファーに必要なサイズを返します。

cchScripts

INT

lpScripts で示されるスクリプトバッファーのサイズ(文字数)です。

あるいは、アプリケーションはこのパラメーターを 0 に設定できます。この場合、関数は lpScripts に NULL を取得し、スクリプトバッファーに必要なサイズを返します。

戻り値の型: INT

公式ドキュメント

指定された Unicode 文字列で使用されているスクリプトの一覧を提供します。

戻り値

成功し、かつ cchScripts が 0 以外の値に設定されている場合、終端の null 文字を含む、出力バッファーに取得された文字数を返します。スクリプトが見つからなかったことを示す場合、関数は 1 を返します。たとえば、入力文字列が COMMON または INHERITED 文字のみを含み、GSS_ALLOW_INHERITED_COMMON が設定されていない場合です。見つかった各スクリプトは 5 文字(4 文字 + 区切り文字)を追加するため、(return_code - 1) / 5 という単純な計算でスクリプト数が得られます。

関数が成功し、cchScripts の値が 0 の場合、関数はスクリプトバッファーに必要なサイズを、終端の null 文字を含む文字数で返します。スクリプト数の求め方は上記のとおりです。

関数が成功しない場合、0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。これは次のいずれかのエラーコードを返す可能性があります。

ERROR_BADDB。関数がデータにアクセスできませんでした。この状況は通常発生せず、一般にインストールの不備、ディスクの問題などを示します。
ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分に大きくないか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

この関数は、国際化ドメイン名(IDN)に関連するセキュリティ問題を軽減する戦略の一部として有用です。

スクリプトの判定は、Unicode コンソーシアムが http://www.unicode.org/Public/4.1.0/ucd/Scripts.txt で公開しているスクリプト値に基づきます。ただし、未割り当て文字は "Zyyy"(COMMON)ではなく "Zzzz"(UNASSIGNED)の値を持ちます。

この関数の動作例を次に示します。

入力文字列		dwFlags	lpScripts	スクリプト
Microsoft.com		0	Latn;	Latin
Microsoft.com		GSS_ALLOW_INHERITED_COMMON	Latn;Zyyy;	Latin + Common
Niño	004E 0069 0241 006F	GSS_ALLOW_INHERITED_COMMON	Latn;	Latin
Niño	LATIN SMALL LETTER N WITH TILDE を使用	GSS_ALLOW_INHERITED_COMMON	Latn;	Latin
Niño	004E 0069 006E 0303 006F	GSS_ALLOW_INHERITED_COMMON	Latn;Qaii;	Latin + Inherited
Niño	COMBINING TILDE を使用	GSS_ALLOW_INHERITED_COMMON	Latn;Qaii;	Latin + Inherited
Spооf	0053 0070 043e 043e 0066	0	Latn;Cyrl;	Latin + Cyrillic
Spооf	CYRILLIC SMALL LETTER O を使用	0	Latn;Cyrl;	Latin + Cyrillic
	U+f000	0	Zzzz;	Unassigned
	U+f000	GSS_ALLOW_INHERITED_COMMON	Zzzz;	Unassigned

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

各言語での呼び出し定義

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

INT GetStringScripts(
    DWORD dwFlags,
    LPCWSTR lpString,
    INT cchString,
    LPWSTR lpScripts,   // optional
    INT cchScripts
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetStringScripts(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpString,   // LPCWSTR
    int cchString,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpScripts,   // LPWSTR optional, out
    int cchScripts   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetStringScripts(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String,   ' LPCWSTR
    cchString As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpScripts As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchScripts As Integer   ' INT
) As Integer
End Function

' dwFlags : DWORD
' lpString : LPCWSTR
' cchString : INT
' lpScripts : LPWSTR optional, out
' cchScripts : INT
Declare PtrSafe Function GetStringScripts Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpString As LongPtr, _
    ByVal cchString As Long, _
    ByVal lpScripts As LongPtr, _
    ByVal cchScripts As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetStringScripts = ctypes.windll.kernel32.GetStringScripts
GetStringScripts.restype = ctypes.c_int
GetStringScripts.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # lpString : LPCWSTR
    ctypes.c_int,  # cchString : INT
    wintypes.LPWSTR,  # lpScripts : LPWSTR optional, out
    ctypes.c_int,  # cchScripts : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetStringScripts = Fiddle::Function.new(
  lib['GetStringScripts'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
    Fiddle::TYPE_INT,  # cchString : INT
    Fiddle::TYPE_VOIDP,  # lpScripts : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchScripts : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetStringScripts(
        dwFlags: u32,  // DWORD
        lpString: *const u16,  // LPCWSTR
        cchString: i32,  // INT
        lpScripts: *mut u16,  // LPWSTR optional, out
        cchScripts: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetStringScripts(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpString, int cchString, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpScripts, int cchScripts);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetStringScripts' -Namespace Win32 -PassThru
# $api::GetStringScripts(dwFlags, lpString, cchString, lpScripts, cchScripts)

#uselib "KERNEL32.dll"
#func global GetStringScripts "GetStringScripts" sptr, sptr, sptr, sptr, sptr
; GetStringScripts dwFlags, lpString, cchString, varptr(lpScripts), cchScripts   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; lpString : LPCWSTR -> "sptr"
; cchString : INT -> "sptr"
; lpScripts : LPWSTR optional, out -> "sptr"
; cchScripts : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetStringScripts "GetStringScripts" int, wstr, int, var, int
; res = GetStringScripts(dwFlags, lpString, cchString, lpScripts, cchScripts)
; dwFlags : DWORD -> "int"
; lpString : LPCWSTR -> "wstr"
; cchString : INT -> "int"
; lpScripts : LPWSTR optional, out -> "var"
; cchScripts : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetStringScripts "GetStringScripts" int, wstr, int, sptr, int
; res = GetStringScripts(dwFlags, lpString, cchString, varptr(lpScripts), cchScripts)
; dwFlags : DWORD -> "int"
; lpString : LPCWSTR -> "wstr"
; cchString : INT -> "int"
; lpScripts : LPWSTR optional, out -> "sptr"
; cchScripts : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。