Win32 API 日本語リファレンス
ホームGlobalization › LocaleNameToLCID

LocaleNameToLCID

関数
ロケール名を対応するロケール識別子に変換する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

DWORD LocaleNameToLCID(
    LPCWSTR lpName,
    DWORD dwFlags
);

パラメーター

名前方向説明
lpNameLPCWSTRin

ロケール名を表す null 終端文字列、または以下の定義済みの値のいずれかへのポインター。

dwFlagsDWORDin

Windows 7 より前:予約済み。常に 0 にする必要があります。

Windows 7 以降: ニュートラルな LCID の返却を許可するために LOCALE_ALLOW_NEUTRAL_NAMES を設定できます。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

成功した場合、ロケール名に対応するロケール識別子を返します。

指定されたロケール名がユーザー既定のカスタムロケールに対応する場合、この関数は LOCALE_CUSTOM_DEFAULT を返します。

ロケール名がユーザー既定ではないカスタムロケール、一時的なロケール、または CLDR (Unicode Common Locale Data Repository) ロケールに対応する場合、この関数は LOCALE_CUSTOM_UNSPECIFIED を返します。

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

解説(Remarks)

Microsoft によって作成されたものを含むカスタムロケールについては、アプリケーションはロケール識別子よりもロケール名を優先する必要があります。詳細については LCID の非推奨化 を参照してください。

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


#include "stdafx.h"
#include "windows.h"
#include "stdio.h"

int _cdecl main(
    int argc,
    char *argv[])
{
    WCHAR strNameBuffer[LOCALE_NAME_MAX_LENGTH];
    DWORD error = ERROR_SUCCESS;
    LCID  lcid;

    // Get the name for locale 0x10407 (German (German), with phonebook sort)
    if (LCIDToLocaleName(0x10407, strNameBuffer, LOCALE_NAME_MAX_LENGTH, 0) == 0)
    {
        // There was an error
        error = GetLastError();
    }
    else
    {
        // Success, display the locale name we found
        wprintf(L"Locale Name for 0x10407 is %s\n", strNameBuffer);
    }

    // Get the LCID for the locale
    lcid = LocaleNameToLCID(strNameBuffer, 0);
    if (lcid == 0)
    {
        // There was an error
        error = GetLastError();
    }
    else
    {
        // Success, print the round trip LCID
        wprintf(L"LCID for %s is 0x%x\n", strNameBuffer, lcid);
    }
}

/* This code example produces the following output:

Locale Name for 0x10407 is de-DE_phoneb
LCID for de-DE_phoneb is 0x10407

*/

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

各言語での呼び出し定義

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

DWORD LocaleNameToLCID(
    LPCWSTR lpName,
    DWORD dwFlags
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint LocaleNameToLCID(
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR
    uint dwFlags   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LocaleNameToLCID(
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String,   ' LPCWSTR
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function
' lpName : LPCWSTR
' dwFlags : DWORD
Declare PtrSafe Function LocaleNameToLCID Lib "kernel32" ( _
    ByVal lpName As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LocaleNameToLCID = ctypes.windll.kernel32.LocaleNameToLCID
LocaleNameToLCID.restype = wintypes.DWORD
LocaleNameToLCID.argtypes = [
    wintypes.LPCWSTR,  # lpName : LPCWSTR
    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')
LocaleNameToLCID = Fiddle::Function.new(
  lib['LocaleNameToLCID'],
  [
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn LocaleNameToLCID(
        lpName: *const u16,  // LPCWSTR
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint LocaleNameToLCID([MarshalAs(UnmanagedType.LPWStr)] string lpName, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LocaleNameToLCID' -Namespace Win32 -PassThru
# $api::LocaleNameToLCID(lpName, dwFlags)
#uselib "KERNEL32.dll"
#func global LocaleNameToLCID "LocaleNameToLCID" sptr, sptr
; LocaleNameToLCID lpName, dwFlags   ; 戻り値は stat
; lpName : LPCWSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global LocaleNameToLCID "LocaleNameToLCID" wstr, int
; res = LocaleNameToLCID(lpName, dwFlags)
; lpName : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; DWORD LocaleNameToLCID(LPCWSTR lpName, DWORD dwFlags)
#uselib "KERNEL32.dll"
#cfunc global LocaleNameToLCID "LocaleNameToLCID" wstr, int
; res = LocaleNameToLCID(lpName, dwFlags)
; lpName : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocaleNameToLCID = kernel32.NewProc("LocaleNameToLCID")
)

// lpName (LPCWSTR), dwFlags (DWORD)
r1, _, err := procLocaleNameToLCID.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpName))),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function LocaleNameToLCID(
  lpName: PWideChar;   // LPCWSTR
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'LocaleNameToLCID';
result := DllCall("KERNEL32\LocaleNameToLCID"
    , "WStr", lpName   ; LPCWSTR
    , "UInt", dwFlags   ; DWORD
    , "UInt")   ; return: DWORD
●LocaleNameToLCID(lpName, dwFlags) = DLL("KERNEL32.dll", "dword LocaleNameToLCID(char*, dword)")
# 呼び出し: LocaleNameToLCID(lpName, dwFlags)
# lpName : LPCWSTR -> "char*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn LocaleNameToLCID(
    lpName: [*c]const u16, // LPCWSTR
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc LocaleNameToLCID(
    lpName: WideCString,  # LPCWSTR
    dwFlags: uint32  # DWORD
): uint32 {.importc: "LocaleNameToLCID", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint LocaleNameToLCID(
    const(wchar)* lpName,   // LPCWSTR
    uint dwFlags   // DWORD
);
ccall((:LocaleNameToLCID, "KERNEL32.dll"), stdcall, UInt32,
      (Cwstring, UInt32),
      lpName, dwFlags)
# lpName : LPCWSTR -> Cwstring
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t LocaleNameToLCID(
    const uint16_t* lpName,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.LocaleNameToLCID(lpName, dwFlags)
-- lpName : LPCWSTR
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const LocaleNameToLCID = lib.func('__stdcall', 'LocaleNameToLCID', 'uint32_t', ['str16', 'uint32_t']);
// LocaleNameToLCID(lpName, dwFlags)
// lpName : LPCWSTR -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  LocaleNameToLCID: { parameters: ["buffer", "u32"], result: "u32" },
});
// lib.symbols.LocaleNameToLCID(lpName, dwFlags)
// lpName : LPCWSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t LocaleNameToLCID(
    const uint16_t* lpName,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->LocaleNameToLCID(lpName, dwFlags);
// lpName : LPCWSTR
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    int LocaleNameToLCID(
        WString lpName,   // LPCWSTR
        int dwFlags   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun LocaleNameToLCID = LocaleNameToLCID(
    lpName : UInt16*,   # LPCWSTR
    dwFlags : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LocaleNameToLCIDNative = Uint32 Function(Pointer<Utf16>, Uint32);
typedef LocaleNameToLCIDDart = int Function(Pointer<Utf16>, int);
final LocaleNameToLCID = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<LocaleNameToLCIDNative, LocaleNameToLCIDDart>('LocaleNameToLCID');
// lpName : LPCWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LocaleNameToLCID(
  lpName: PWideChar;   // LPCWSTR
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'LocaleNameToLCID';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LocaleNameToLCID"
  c_LocaleNameToLCID :: CWString -> Word32 -> IO Word32
-- lpName : LPCWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let localenametolcid =
  foreign "LocaleNameToLCID"
    ((ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("LocaleNameToLCID" locale-name-to-lcid :convention :stdcall) :uint32
  (lp-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LocaleNameToLCID = Win32::API::More->new('KERNEL32',
    'DWORD LocaleNameToLCID(LPCWSTR lpName, DWORD dwFlags)');
# my $ret = $LocaleNameToLCID->Call($lpName, $dwFlags);
# lpName : LPCWSTR -> LPCWSTR
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。