LCIDToLocaleName

関数

ロケール識別子を対応するロケール名に変換する。

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

シグネチャ

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

INT LCIDToLocaleName(
    DWORD Locale,
    LPWSTR lpName,   // optional
    INT cchName,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	変換するロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT Windows Vista: 次のカスタムロケール識別子もサポートされます。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED
lpName	LPWSTR	outoptional	この関数がロケール名を取得するバッファーへのポインター、または次の定義済みの値のいずれか。 LOCALE_NAME_INVARIANT LOCALE_NAME_SYSTEM_DEFAULT LOCALE_NAME_USER_DEFAULT
cchName	INT	in	ロケール名バッファーのサイズ(文字数)。終端の null 文字を含むロケール名の最大長は LOCALE_NAME_MAX_LENGTH です。これがこのパラメーターに指定することを推奨するサイズです。あるいは、アプリケーションはこのパラメーターを 0 に設定することもできます。この場合、関数はロケール名バッファーに必要なサイズを返します。
dwFlags	DWORD	in	Windows 7 より前: 予約済みです。常に 0 にする必要があります。 Windows 7 以降: LOCALE_ALLOW_NEUTRAL_NAMES を設定して、ニュートラル名の返却を許可できます。

戻り値の型: INT

公式ドキュメント

ロケール識別子をロケール名に変換します。

戻り値

成功した場合、終端の null 文字を含むロケール名の文字数を返します。関数が成功し、cchName の値が 0 の場合、戻り値はロケール名バッファーに必要なサイズ(null 文字を含む文字数)です。

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

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

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

各言語での呼び出し定義

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

INT LCIDToLocaleName(
    DWORD Locale,
    LPWSTR lpName,   // optional
    INT cchName,
    DWORD dwFlags
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int LCIDToLocaleName(
    uint Locale,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpName,   // LPWSTR optional, out
    int cchName,   // INT
    uint dwFlags   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LCIDToLocaleName(
    Locale As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpName As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchName As Integer,   ' INT
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' Locale : DWORD
' lpName : LPWSTR optional, out
' cchName : INT
' dwFlags : DWORD
Declare PtrSafe Function LCIDToLocaleName Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal lpName As LongPtr, _
    ByVal cchName As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LCIDToLocaleName = ctypes.windll.kernel32.LCIDToLocaleName
LCIDToLocaleName.restype = ctypes.c_int
LCIDToLocaleName.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.LPWSTR,  # lpName : LPWSTR optional, out
    ctypes.c_int,  # cchName : INT
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LCIDToLocaleName = Fiddle::Function.new(
  lib['LCIDToLocaleName'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    Fiddle::TYPE_VOIDP,  # lpName : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchName : INT
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn LCIDToLocaleName(
        Locale: u32,  // DWORD
        lpName: *mut u16,  // LPWSTR optional, out
        cchName: i32,  // INT
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int LCIDToLocaleName(uint Locale, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpName, int cchName, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LCIDToLocaleName' -Namespace Win32 -PassThru
# $api::LCIDToLocaleName(Locale, lpName, cchName, dwFlags)

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

出力引数:

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