GetLocaleInfoA

関数

指定ロケールの各種情報を取得する。ANSI版。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetLocaleInfoA(
    DWORD Locale,
    DWORD LCType,
    LPSTR lpLCData,   // optional
    INT cchData
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	情報を取得する対象のロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT
LCType	DWORD	in	取得するロケール情報。詳細な定義については、GetLocaleInfoEx の LCType パラメーターを参照してください。注意 GetLocaleInfo では、値 LOCALE_USE_CP_ACP は ANSI 版でのみ意味を持ちます。
lpLCData	LPSTR	outoptional	この関数が要求されたロケール情報を取得するバッファーへのポインター。cchData が 0 に設定されている場合、このポインターは使用されません。詳細については、「解説」セクションを参照してください。
cchData	INT	in	lpLCData で示されるデータバッファーのサイズ(TCHAR 値単位)。あるいは、アプリケーションはこのパラメーターを 0 に設定することもできます。その場合、関数は lpLCData パラメーターを使用せず、終端の null 文字を含む必要なバッファーサイズを返します。

戻り値の型: INT

公式ドキュメント

識別子で指定されたロケールに関する情報を取得します。(ANSI)

戻り値

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

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

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

解説(Remarks)

この関数の動作については、GetLocaleInfoEx の「解説」を参照してください。

注意 LCType パラメーターに LOCALE_FONTSIGNATURE が指定されている場合でも、cchData と関数の戻り値は依然として TCHAR 単位のカウントです。このカウントは関数の ANSI 版と Unicode 版で異なります。アプリケーションが LOCALE_FONTSIGNATURE を指定して汎用版の GetLocaleInfo を呼び出す場合、cchData は sizeof(LOCALESIGNATURE) / sizeof(TCHAR) として安全に指定できます。

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

int   ret;
CALID calid;
DWORD value;

ret = GetLocaleInfo(LOCALE_USER_DEFAULT,
                    LOCALE_ICALENDARTYPE | LOCALE_RETURN_NUMBER,
                    (LPTSTR)&value,
                    sizeof(value) / sizeof(TCHAR) );
calid = value;

LOCALESIGNATURE LocSig;

ret = GetLocaleInfo(LOCALE_USER_DEFAULT,
                    LOCALE_FONTSIGNATURE,
                    (LPWSTR)&LocSig,
                    sizeof(LocSig) / sizeof(TCHAR) );

この関数の ANSI 版が取得する ANSI 文字列は、ロケール識別子に対する既定の ANSI コードページに基づいて Unicode から ANSI に変換されます。ただし、LOCALE_USE_CP_ACP が指定されている場合、変換はシステム既定の ANSI コードページに基づきます。

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

メモ

winnls.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetLocaleInfo を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーやランタイムエラーを引き起こす不一致につながる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT GetLocaleInfoA(
    DWORD Locale,
    DWORD LCType,
    LPSTR lpLCData,   // optional
    INT cchData
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetLocaleInfoA(
    uint Locale,   // DWORD
    uint LCType,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpLCData,   // LPSTR optional, out
    int cchData   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLocaleInfoA(
    Locale As UInteger,   ' DWORD
    LCType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpLCData As System.Text.StringBuilder,   ' LPSTR optional, out
    cchData As Integer   ' INT
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

GetLocaleInfoA = ctypes.windll.kernel32.GetLocaleInfoA
GetLocaleInfoA.restype = ctypes.c_int
GetLocaleInfoA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # LCType : DWORD
    wintypes.LPSTR,  # lpLCData : LPSTR 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')
GetLocaleInfoA = Fiddle::Function.new(
  lib['GetLocaleInfoA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # LCType : DWORD
    Fiddle::TYPE_VOIDP,  # lpLCData : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchData : INT
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetLocaleInfoA(uint Locale, uint LCType, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpLCData, int cchData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetLocaleInfoA' -Namespace Win32 -PassThru
# $api::GetLocaleInfoA(Locale, LCType, lpLCData, cchData)

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

出力引数:

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