ResolveLocaleName

関数

指定したロケール名を最も近い有効なロケール名に解決する。

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

シグネチャ

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

INT ResolveLocaleName(
    LPCWSTR lpNameToResolve,   // optional
    LPWSTR lpLocaleName,   // optional
    INT cchLocaleName
);

パラメーター

名前	型	方向	説明
lpNameToResolve	LPCWSTR	inoptional	解決する名前へのポインター。たとえば、英語 (私用) を表す "en-XA" などです。
lpLocaleName	LPWSTR	outoptional	この関数が入力名に一致するロケール名を取得するバッファーへのポインター。たとえば、名前 "en-XA" に一致するのは、英語 (米国) を表す "en-US" です。注意関数が失敗した場合、出力バッファーの状態が正確である保証はありません。この場合、アプリケーションは関数が設定した戻り値とエラー状態を確認し、適切な対処を判断する必要があります。
cchLocaleName	INT	in	lpLocaleName が示すバッファーのサイズ (文字数)。終端の null 文字を含むロケール名の最大長は、LOCALE_NAME_MAX_LENGTH の値です。このパラメーターには、このサイズを指定することを推奨します。

戻り値の型: INT

公式ドキュメント

指定された名前に一致する可能性のあるロケール名を検索します。

戻り値

成功した場合、終端の null 文字を含む、ロケール名を格納するバッファーのサイズを返します。

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

ERROR_INSUFFICIENT_BUFFER. 指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。

解説(Remarks)

取得されるロケール名は、入力言語がニュートラルな場合でも、言語と国/地域を含む特定のロケールを示します。たとえば、英語 (米国) を表す "en" を入力すると、この関数は "en-US" を取得します。

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

Windows 8 以降: Windows.Globalization 名前空間から取得した言語タグは、各種の National Language Support 関数で使用する前に ResolveLocaleName で変換する必要があります。

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

各言語での呼び出し定義

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

INT ResolveLocaleName(
    LPCWSTR lpNameToResolve,   // optional
    LPWSTR lpLocaleName,   // optional
    INT cchLocaleName
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int ResolveLocaleName(
    [MarshalAs(UnmanagedType.LPWStr)] string lpNameToResolve,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpLocaleName,   // LPWSTR optional, out
    int cchLocaleName   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ResolveLocaleName(
    <MarshalAs(UnmanagedType.LPWStr)> lpNameToResolve As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchLocaleName As Integer   ' INT
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

ResolveLocaleName = ctypes.windll.kernel32.ResolveLocaleName
ResolveLocaleName.restype = ctypes.c_int
ResolveLocaleName.argtypes = [
    wintypes.LPCWSTR,  # lpNameToResolve : LPCWSTR optional
    wintypes.LPWSTR,  # lpLocaleName : LPWSTR optional, out
    ctypes.c_int,  # cchLocaleName : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ResolveLocaleName = Fiddle::Function.new(
  lib['ResolveLocaleName'],
  [
    Fiddle::TYPE_VOIDP,  # lpNameToResolve : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchLocaleName : INT
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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

出力引数:

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

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procResolveLocaleName = kernel32.NewProc("ResolveLocaleName")
)

// lpNameToResolve (LPCWSTR optional), lpLocaleName (LPWSTR optional, out), cchLocaleName (INT)
r1, _, err := procResolveLocaleName.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNameToResolve))),
	uintptr(lpLocaleName),
	uintptr(cchLocaleName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function ResolveLocaleName(
  lpNameToResolve: PWideChar;   // LPCWSTR optional
  lpLocaleName: PWideChar;   // LPWSTR optional, out
  cchLocaleName: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'ResolveLocaleName';

result := DllCall("KERNEL32\ResolveLocaleName"
    , "WStr", lpNameToResolve   ; LPCWSTR optional
    , "Ptr", lpLocaleName   ; LPWSTR optional, out
    , "Int", cchLocaleName   ; INT
    , "Int")   ; return: INT

●ResolveLocaleName(lpNameToResolve, lpLocaleName, cchLocaleName) = DLL("KERNEL32.dll", "int ResolveLocaleName(char*, char*, int)")
# 呼び出し: ResolveLocaleName(lpNameToResolve, lpLocaleName, cchLocaleName)
# lpNameToResolve : LPCWSTR optional -> "char*"
# lpLocaleName : LPWSTR optional, out -> "char*"
# cchLocaleName : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn ResolveLocaleName(
    lpNameToResolve: [*c]const u16, // LPCWSTR optional
    lpLocaleName: [*c]u16, // LPWSTR optional, out
    cchLocaleName: i32 // INT
) callconv(std.os.windows.WINAPI) i32;

proc ResolveLocaleName(
    lpNameToResolve: WideCString,  # LPCWSTR optional
    lpLocaleName: ptr uint16,  # LPWSTR optional, out
    cchLocaleName: int32  # INT
): int32 {.importc: "ResolveLocaleName", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int ResolveLocaleName(
    const(wchar)* lpNameToResolve,   // LPCWSTR optional
    wchar* lpLocaleName,   // LPWSTR optional, out
    int cchLocaleName   // INT
);

ccall((:ResolveLocaleName, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt16}, Int32),
      lpNameToResolve, lpLocaleName, cchLocaleName)
# lpNameToResolve : LPCWSTR optional -> Cwstring
# lpLocaleName : LPWSTR optional, out -> Ptr{UInt16}
# cchLocaleName : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t ResolveLocaleName(
    const uint16_t* lpNameToResolve,
    uint16_t* lpLocaleName,
    int32_t cchLocaleName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ResolveLocaleName(lpNameToResolve, lpLocaleName, cchLocaleName)
-- lpNameToResolve : LPCWSTR optional
-- lpLocaleName : LPWSTR optional, out
-- cchLocaleName : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ResolveLocaleName = lib.func('__stdcall', 'ResolveLocaleName', 'int32_t', ['str16', 'uint16_t *', 'int32_t']);
// ResolveLocaleName(lpNameToResolve, lpLocaleName, cchLocaleName)
// lpNameToResolve : LPCWSTR optional -> 'str16'
// lpLocaleName : LPWSTR optional, out -> 'uint16_t *'
// cchLocaleName : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  ResolveLocaleName: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.ResolveLocaleName(lpNameToResolve, lpLocaleName, cchLocaleName)
// lpNameToResolve : LPCWSTR optional -> "buffer"
// lpLocaleName : LPWSTR optional, out -> "buffer"
// cchLocaleName : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t ResolveLocaleName(
    const uint16_t* lpNameToResolve,
    uint16_t* lpLocaleName,
    int32_t cchLocaleName);
C, "KERNEL32.dll");
// $ffi->ResolveLocaleName(lpNameToResolve, lpLocaleName, cchLocaleName);
// lpNameToResolve : LPCWSTR optional
// lpLocaleName : LPWSTR optional, out
// cchLocaleName : INT
// 構造体/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 ResolveLocaleName(
        WString lpNameToResolve,   // LPCWSTR optional
        char[] lpLocaleName,   // LPWSTR optional, out
        int cchLocaleName   // INT
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun ResolveLocaleName = ResolveLocaleName(
    lpNameToResolve : UInt16*,   # LPCWSTR optional
    lpLocaleName : UInt16*,   # LPWSTR optional, out
    cchLocaleName : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ResolveLocaleNameNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32);
typedef ResolveLocaleNameDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final ResolveLocaleName = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ResolveLocaleNameNative, ResolveLocaleNameDart>('ResolveLocaleName');
// lpNameToResolve : LPCWSTR optional -> Pointer<Utf16>
// lpLocaleName : LPWSTR optional, out -> Pointer<Utf16>
// cchLocaleName : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function ResolveLocaleName(
  lpNameToResolve: PWideChar;   // LPCWSTR optional
  lpLocaleName: PWideChar;   // LPWSTR optional, out
  cchLocaleName: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'ResolveLocaleName';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ResolveLocaleName"
  c_ResolveLocaleName :: CWString -> CWString -> Int32 -> IO Int32
-- lpNameToResolve : LPCWSTR optional -> CWString
-- lpLocaleName : LPWSTR optional, out -> CWString
-- cchLocaleName : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let resolvelocalename =
  foreign "ResolveLocaleName"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* lpNameToResolve : LPCWSTR optional -> (ptr uint16_t) *)
(* lpLocaleName : LPWSTR optional, out -> (ptr uint16_t) *)
(* cchLocaleName : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ResolveLocaleName" resolve-locale-name :convention :stdcall) :int32
  (lp-name-to-resolve (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-locale-name :pointer)   ; LPWSTR optional, out
  (cch-locale-name :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $ResolveLocaleName = Win32::API::More->new('KERNEL32',
    'int ResolveLocaleName(LPCWSTR lpNameToResolve, LPWSTR lpLocaleName, int cchLocaleName)');
# my $ret = $ResolveLocaleName->Call($lpNameToResolve, $lpLocaleName, $cchLocaleName);
# lpNameToResolve : LPCWSTR optional -> LPCWSTR
# lpLocaleName : LPWSTR optional, out -> LPWSTR
# cchLocaleName : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。