GetStringTypeExA

関数

ANSI文字列内各文字の文字種情報を取得する。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

BOOL GetStringTypeExA(
    DWORD Locale,
    DWORD dwInfoType,
    LPCSTR lpSrcStr,
    INT cchSrc,
    WORD* lpCharType
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	ロケールを指定するロケール識別子です。この値は ANSI コードページを一意に定義します。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT Windows Vista 以降: 次のカスタムロケール識別子もサポートされています。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED
dwInfoType	DWORD	in	取得する文字種別情報を指定するフラグです。指定可能なフラグ値については、GetStringTypeW の dwInfoType パラメーターを参照してください。文字種別ビットの詳細については、GetStringTypeW の「解説」を参照してください。
lpSrcStr	LPCSTR	in	文字種別を取得する対象の文字列へのポインターです。cchSrc に負の値が設定されている場合、この文字列は null 終端であると見なされます。
cchSrc	INT	in	lpSrcStr で示される文字列のサイズ(文字数)です。このサイズは、この関数の ANSI 版ではバイト数を、Unicode 版ではワイド文字数を表します。サイズに終端の null 文字が含まれている場合、関数はその文字についても文字種別情報を取得します。アプリケーションがサイズに負の整数を設定した場合、ソース文字列は null 終端であると見なされ、関数は null 終端用の 1 文字を加えたサイズを自動的に計算します。
lpCharType	WORD*	out	16 ビット値の配列へのポインターです。この配列の長さは、ソース文字列内の各文字に対応する 16 ビット値を 1 つずつ格納できる十分な大きさである必要があります。cchSrc が負の数でない場合、lpCharType は cchSrc 個の要素を持つワードの配列である必要があります。cchSrc が負の数に設定されている場合、lpCharType は lpSrcStr + 1 個の要素を持つワードの配列になります。関数が戻ると、この配列にはソース文字列内の各文字に対応するワードが 1 つずつ格納されます。

戻り値の型: BOOL

公式ドキュメント

指定されたソース文字列内の文字について、文字種別情報を取得します。

戻り値

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

ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

重要

GetStringTypeEx 関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。バッファーオーバーフローを回避するため、アプリケーションは出力バッファーのサイズを正しく設定する必要があります。セキュリティに関する詳細については、セキュリティに関する考慮事項: Windows ユーザーインターフェイスを参照してください。

この関数は、近い関係にある GetStringTypeA や GetStringTypeW とは異なり、#define UNICODE スイッチを使用することで、ANSI または Unicode の適切な動作を示します。文字種別の取得には、この関数を使用することが推奨されます。

文字列関数の使用方法の概要については、Stringsを参照してください。

この関数は、指定されたロケールの ANSI コードページを使用して、ソース文字列を ANSI から Unicode に変換します。その後、各 Unicode 文字を分析して文字種別情報を取得します。

この関数の ANSI 版は、ソース文字列を Unicode に変換し、対応する GetStringTypeW 関数を呼び出します。そのため、出力バッファー内のワードは、元の ANSI 文字列ではなく、その Unicode 相当の文字列に対応します。ANSI から Unicode への変換では文字列の長さが変化することがあり、たとえば 1 対の ANSI 文字が 1 つの Unicode 文字にマップされる場合があります。したがって、出力バッファー内のワードと元の ANSI 文字列内の文字との対応は、たとえばマルチバイト文字列のように、すべての場合において 1 対 1 になるとは限りません。このため、この関数の ANSI 版は複数文字の文字列に対しては用途が限られます。代わりに Unicode 版の関数を使用することが推奨されます。

この関数は、GetStringTypeA と GetStringTypeW の間のパラメーターの違いによって生じる制限を回避します。パラメーターの違いがあるため、アプリケーションは #define UNICODE スイッチを使用して GetStringType* 関数の適切な ANSI 版または Unicode 版を自動的に呼び出すことができません。一方、GetStringTypeEx はそのスイッチに対して適切に動作します。したがって、こちらが推奨される関数です。

この関数の ANSI 版を Unicode 専用のロケール識別子とともに使用した場合、オペレーティングシステムがシステムコードページを使用するため、関数は成功することがあります。ただし、システムコードページで未定義の文字は、文字列内で疑問符 (?) として表示されます。

lpSrcStr と lpCharType パラメーターの値は同一であってはなりません。同一の場合、関数は ERROR_INVALID_PARAMETER で失敗します。

Locale パラメーターは、文字列を Unicode に変換する処理にのみ使用されます。これは、アプリケーションが提供する CTYPE* の値とは関係ありません。これらの値は Unicode コードポイントによってのみ決定され、ロケールに応じて変化することはありません。たとえば、ギリシャ文字は Locale の値にかかわらず C1_ALPHA として指定されます。

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

各言語での呼び出し定義

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

BOOL GetStringTypeExA(
    DWORD Locale,
    DWORD dwInfoType,
    LPCSTR lpSrcStr,
    INT cchSrc,
    WORD* lpCharType
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool GetStringTypeExA(
    uint Locale,   // DWORD
    uint dwInfoType,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpSrcStr,   // LPCSTR
    int cchSrc,   // INT
    out ushort lpCharType   // WORD* out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetStringTypeExA(
    Locale As UInteger,   ' DWORD
    dwInfoType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpSrcStr As String,   ' LPCSTR
    cchSrc As Integer,   ' INT
    <Out> ByRef lpCharType As UShort   ' WORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Locale : DWORD
' dwInfoType : DWORD
' lpSrcStr : LPCSTR
' cchSrc : INT
' lpCharType : WORD* out
Declare PtrSafe Function GetStringTypeExA Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwInfoType As Long, _
    ByVal lpSrcStr As String, _
    ByVal cchSrc As Long, _
    ByRef lpCharType As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetStringTypeExA = ctypes.windll.kernel32.GetStringTypeExA
GetStringTypeExA.restype = wintypes.BOOL
GetStringTypeExA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwInfoType : DWORD
    wintypes.LPCSTR,  # lpSrcStr : LPCSTR
    ctypes.c_int,  # cchSrc : INT
    ctypes.POINTER(ctypes.c_ushort),  # lpCharType : WORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetStringTypeExA = Fiddle::Function.new(
  lib['GetStringTypeExA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwInfoType : DWORD
    Fiddle::TYPE_VOIDP,  # lpSrcStr : LPCSTR
    Fiddle::TYPE_INT,  # cchSrc : INT
    Fiddle::TYPE_VOIDP,  # lpCharType : WORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetStringTypeExA(
        Locale: u32,  // DWORD
        dwInfoType: u32,  // DWORD
        lpSrcStr: *const u8,  // LPCSTR
        cchSrc: i32,  // INT
        lpCharType: *mut u16  // WORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern bool GetStringTypeExA(uint Locale, uint dwInfoType, [MarshalAs(UnmanagedType.LPStr)] string lpSrcStr, int cchSrc, out ushort lpCharType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetStringTypeExA' -Namespace Win32 -PassThru
# $api::GetStringTypeExA(Locale, dwInfoType, lpSrcStr, cchSrc, lpCharType)

#uselib "KERNEL32.dll"
#func global GetStringTypeExA "GetStringTypeExA" sptr, sptr, sptr, sptr, sptr
; GetStringTypeExA Locale, dwInfoType, lpSrcStr, cchSrc, varptr(lpCharType)   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwInfoType : DWORD -> "sptr"
; lpSrcStr : LPCSTR -> "sptr"
; cchSrc : INT -> "sptr"
; lpCharType : WORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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