GetLocaleInfoEx

関数

ロケール名を指定してロケール情報を取得する。

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

シグネチャ

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

INT GetLocaleInfoEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD LCType,
    LPWSTR lpLCData,   // optional
    INT cchData
);

パラメーター

名前	型	方向	説明
lpLocaleName	LPCWSTR	inoptional	ロケール名、または次のいずれかの定義済みの値へのポインターです。 LOCALE_NAME_INVARIANT LOCALE_NAME_SYSTEM_DEFAULT LOCALE_NAME_USER_DEFAULT
LCType	DWORD	in	取得するロケール情報です。指定可能な値については、Locale Information Constants の「Constants Used in the LCType Parameter of GetLocaleInfo, GetLocaleInfoEx, and SetLocaleInfo」セクションを参照してください。1 回の呼び出しで指定できるロケール情報は 1 つだけである点に注意してください。アプリケーションは、ビットごとの OR 演算子を使用して、LOCALE_RETURN_NUMBER を許可されている他の任意の定数と組み合わせることができます。この場合、関数は値を文字列ではなく数値として取得します。値を受け取るバッファーは、少なくとも DWORD 値の長さ（すなわち 2）が必要です。注意 LOCALE_NOUSEROVERRIDE を他の任意の定数と組み合わせることも可能です。ただし、この定数の使用は強く推奨されません。（現在のユーザーオーバーライドを使用しない場合であっても、データはコンピューターごとに異なる可能性があり、カスタムロケールによってデータが変化することがあります。たとえば、月名や曜日名でさえ、表記改革の影響を受けることがあります。） LCType に LOCALE_IOPTIONALCALENDAR を設定した場合、関数は最初の代替カレンダーのみを取得します。注意すべての代替カレンダーを取得するには、アプリケーションは EnumCalendarInfoEx を使用してください。 Windows Vista 以降では、失敗や予期しないデータの取得を避けるため、アプリケーションの LCType パラメーターで LOCALE_ILANGUAGE を使用しないでください。代わりに GetLocaleInfoEx を呼び出すことが推奨されます。
lpLCData	LPWSTR	outoptional	要求されたロケール情報をこの関数が取得するバッファーへのポインターです。cchData が 0 に設定されている場合、このポインターは使用されません。
cchData	INT	in	lpLCData が指すデータバッファーのサイズ（文字数）です。あるいは、アプリケーションはこのパラメーターを 0 に設定することもできます。この場合、関数は lpLCData パラメーターを使用せず、終端の null 文字を含む必要なバッファーサイズを返します。

戻り値の型: INT

公式ドキュメント

名前で指定したロケールに関する情報を取得します。注意 Windows Vista 以降でのみ動作するように設計されたアプリケーションは、GetLocaleInfo よりもこの関数を優先して呼び出してください。注意この関数は、カスタムロケールなどが原因でリリース間で変化するデータを取得することがあります。アプリケーションがデータを永続化または送信する必要がある場合は、「Using Persistent Locale Data」を参照してください。

戻り値

処理に成功し、かつ cchData が 0 以外の値である場合、ロケールデータバッファーに取得された文字数を返します。関数が成功し、cchData が 0 以外で、かつ LOCALE_RETURN_NUMBER が指定されている場合、戻り値はデータバッファーに取得された整数のサイズ、すなわち 2 です。関数が成功し、cchData の値が 0 の場合、戻り値はロケールデータバッファーに必要なサイズ（null 文字を含む文字数）です。

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

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分に大きくなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

この関数は通常、情報をテキスト形式で取得します。情報が数値で、LCType の値が LOCALE_ILANGUAGE または LOCALE_IDEFAULTLANGUAGE の場合、この関数は 16 進数を含む文字列を取得します。それ以外の場合、数値情報として取得されるテキストは 10 進数です。

この規則には 2 つの例外があります。1 つ目は、アプリケーションが LCType パラメーターに LOCALE_RETURN_NUMBER を指定することで、数値を整数として取得できることです。2 つ目の例外は、LOCALE_FONTSIGNATURE が他のすべてのロケール情報定数とは異なる動作をすることです。アプリケーションは、少なくとも sizeof(LOCALESIGNATURE) バイトのデータバッファーを用意する必要があります。関数が正常に復帰すると、バッファーは LOCALESIGNATURE 構造体として埋められます。

注意 LCType パラメーターに LOCALE_FONTSIGNATURE を指定した場合でも、cchData および関数の戻り値は依然として文字数です。アプリケーションが LCType に LOCALE_FONTSIGNATURE を指定して GetLocaleInfoEx を呼び出す場合、cchData には sizeof(LOCALESIGNATURE) / sizeof(WCHAR) を安全に指定できます。

次の例は、テキスト以外の値に対するバッファーサイズを正しく扱っています。

int   ret;
CALID calid;
DWORD value;

ret = GetLocaleInfoEx(LOCALE_NAME_USER_DEFAULT,
                      LOCALE_ICALENDARTYPE | LOCALE_RETURN_NUMBER,
                      (LPWSTR)&value,
                      sizeof(value) / sizeof(WCHAR) );
calid = value;

LOCALESIGNATURE LocSig;

ret = GetLocaleInfoEx(LOCALE_NAME_USER_DEFAULT,
                      LOCALE_FONTSIGNATURE,
                      (LPWSTR)&LocSig,
                      sizeof(LocSig) / sizeof(WCHAR) );

この関数はカスタムロケールからデータを取得できます。データはコンピューターごとに、またはアプリケーションの実行ごとに同一であることが保証されません。アプリケーションがデータを永続化または送信する必要がある場合は、Using Persistent Locale Data を参照してください。

Windows 8 以降: アプリケーションが Windows.Globalization 名前空間から言語タグをこの関数に渡す場合は、まず ResolveLocaleName を呼び出してタグを変換する必要があります。

Examples

この関数の使用例は、NLS: Name-based APIs Sample および NLS: Internationalized Domain Name (IDN) Mitigation Sample にあります。

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

各言語での呼び出し定義

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

INT GetLocaleInfoEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD LCType,
    LPWSTR lpLCData,   // optional
    INT cchData
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetLocaleInfoEx(
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    uint LCType,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpLCData,   // LPWSTR optional, out
    int cchData   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLocaleInfoEx(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    LCType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpLCData As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchData As Integer   ' INT
) As Integer
End Function

' lpLocaleName : LPCWSTR optional
' LCType : DWORD
' lpLCData : LPWSTR optional, out
' cchData : INT
Declare PtrSafe Function GetLocaleInfoEx Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr, _
    ByVal LCType As Long, _
    ByVal lpLCData As LongPtr, _
    ByVal cchData As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetLocaleInfoEx = ctypes.windll.kernel32.GetLocaleInfoEx
GetLocaleInfoEx.restype = ctypes.c_int
GetLocaleInfoEx.argtypes = [
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    wintypes.DWORD,  # LCType : DWORD
    wintypes.LPWSTR,  # lpLCData : LPWSTR optional, out
    ctypes.c_int,  # cchData : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetLocaleInfoEx = Fiddle::Function.new(
  lib['GetLocaleInfoEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # LCType : DWORD
    Fiddle::TYPE_VOIDP,  # lpLCData : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchData : INT
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetLocaleInfoEx([MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName, uint LCType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpLCData, int cchData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetLocaleInfoEx' -Namespace Win32 -PassThru
# $api::GetLocaleInfoEx(lpLocaleName, LCType, lpLCData, cchData)

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

出力引数:

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