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

GetUserPreferredUILanguages

関数
ユーザーの優先UI言語一覧を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetUserPreferredUILanguages(
    DWORD dwFlags,
    DWORD* pulNumLanguages,
    LPWSTR pwszLanguagesBuffer,   // optional
    DWORD* pcchLanguagesBuffer
);

パラメーター

名前方向説明
dwFlagsDWORDin

言語の形式とフィルタリングを指定するフラグです。次のフラグは、表示言語リストに使用する言語形式を指定します。これらのフラグは相互に排他的であり、既定は MUI_LANGUAGE_NAME です。

意味
MUI_LANGUAGE_ID 言語文字列を language identifier 形式で取得します。
MUI_LANGUAGE_NAME 言語文字列を language name 形式で取得します。
pulNumLanguagesDWORD*outpwszLanguagesBuffer に取得された言語数へのポインターです。
pwszLanguagesBufferLPWSTRoutoptional

省略可能。この関数が、dwflags で指定された形式の、順序付けされた null 区切りの表示言語リストを取得するバッファーへのポインターです。このリストは 2 つの null 文字で終わります。

あるいは、このパラメーターを NULL に設定し、pcchLanguagesBuffer を 0 に設定すると、関数は必要な言語バッファーのサイズを pcchLanguagesBuffer に取得します。必要なサイズには 2 つの null 文字が含まれます。

pcchLanguagesBufferDWORD*inout

pwszLanguagesBuffer が示す言語バッファーのサイズ(文字数)へのポインターです。関数が正常に戻ると、このパラメーターには取得された言語バッファーのサイズが格納されます。

あるいは、このパラメーターを 0 に設定し、pwszLanguagesBufferNULL に設定すると、関数は必要な言語バッファーのサイズを pcchLanguagesBuffer に取得します。

戻り値の型: BOOL

公式ドキュメント

ユーザー優先 UI 言語に関する情報を取得します。詳細については「User Interface Language Management」を参照してください。

戻り値

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

その他の理由で関数が失敗した場合、pulNumLanguagespcchLanguagesBuffer の値は未定義です。

解説(Remarks)

MUI_LANGUAGE_ID を指定した場合、取得される言語文字列は先頭の 0x を含まない 16 進数の言語識別子となり、長さは 4 文字になります。たとえば、en-US は "0409"、en は "0009" として返されます。

表示言語には、supplemental locale に対応する Language Interface Pack (LIP) 言語を複数含めることはできません。リストにこれらの言語が複数含まれており、かつアプリケーションが関数の呼び出しで MUI_LANGUAGE_ID を指定した場合、言語バッファーにはその言語として "1400" が格納されます。この文字列は LOCALE_CUSTOM_UI_DEFAULT の 16 進数値に対応します。

この関数で取得される言語リストには次の特性があります。

C# Signature

[DllImport("Kernel32.dll", CharSet = CharSet.Auto)]
        static extern System.Boolean GetUserPreferredUILanguages(
            System.UInt32 dwFlags,
            ref System.UInt32 pulNumLanguages,
            System.IntPtr pwszLanguagesBuffer,
            ref System.UInt32 pcchLanguagesBuffer
            );
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL GetUserPreferredUILanguages(
    DWORD dwFlags,
    DWORD* pulNumLanguages,
    LPWSTR pwszLanguagesBuffer,   // optional
    DWORD* pcchLanguagesBuffer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetUserPreferredUILanguages(
    uint dwFlags,   // DWORD
    out uint pulNumLanguages,   // DWORD* out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszLanguagesBuffer,   // LPWSTR optional, out
    ref uint pcchLanguagesBuffer   // DWORD* in/out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUserPreferredUILanguages(
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef pulNumLanguages As UInteger,   ' DWORD* out
    <MarshalAs(UnmanagedType.LPWStr)> pwszLanguagesBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchLanguagesBuffer As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwFlags : DWORD
' pulNumLanguages : DWORD* out
' pwszLanguagesBuffer : LPWSTR optional, out
' pcchLanguagesBuffer : DWORD* in/out
Declare PtrSafe Function GetUserPreferredUILanguages Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByRef pulNumLanguages As Long, _
    ByVal pwszLanguagesBuffer As LongPtr, _
    ByRef pcchLanguagesBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetUserPreferredUILanguages = ctypes.windll.kernel32.GetUserPreferredUILanguages
GetUserPreferredUILanguages.restype = wintypes.BOOL
GetUserPreferredUILanguages.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pulNumLanguages : DWORD* out
    wintypes.LPWSTR,  # pwszLanguagesBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchLanguagesBuffer : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetUserPreferredUILanguages = Fiddle::Function.new(
  lib['GetUserPreferredUILanguages'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pulNumLanguages : DWORD* out
    Fiddle::TYPE_VOIDP,  # pwszLanguagesBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchLanguagesBuffer : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetUserPreferredUILanguages(
        dwFlags: u32,  // DWORD
        pulNumLanguages: *mut u32,  // DWORD* out
        pwszLanguagesBuffer: *mut u16,  // LPWSTR optional, out
        pcchLanguagesBuffer: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetUserPreferredUILanguages(uint dwFlags, out uint pulNumLanguages, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszLanguagesBuffer, ref uint pcchLanguagesBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetUserPreferredUILanguages' -Namespace Win32 -PassThru
# $api::GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
#uselib "KERNEL32.dll"
#func global GetUserPreferredUILanguages "GetUserPreferredUILanguages" sptr, sptr, sptr, sptr
; GetUserPreferredUILanguages dwFlags, varptr(pulNumLanguages), varptr(pwszLanguagesBuffer), varptr(pcchLanguagesBuffer)   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; pulNumLanguages : DWORD* out -> "sptr"
; pwszLanguagesBuffer : LPWSTR optional, out -> "sptr"
; pcchLanguagesBuffer : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetUserPreferredUILanguages "GetUserPreferredUILanguages" int, var, var, var
; res = GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
; dwFlags : DWORD -> "int"
; pulNumLanguages : DWORD* out -> "var"
; pwszLanguagesBuffer : LPWSTR optional, out -> "var"
; pcchLanguagesBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetUserPreferredUILanguages(DWORD dwFlags, DWORD* pulNumLanguages, LPWSTR pwszLanguagesBuffer, DWORD* pcchLanguagesBuffer)
#uselib "KERNEL32.dll"
#cfunc global GetUserPreferredUILanguages "GetUserPreferredUILanguages" int, var, var, var
; res = GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
; dwFlags : DWORD -> "int"
; pulNumLanguages : DWORD* out -> "var"
; pwszLanguagesBuffer : LPWSTR optional, out -> "var"
; pcchLanguagesBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetUserPreferredUILanguages = kernel32.NewProc("GetUserPreferredUILanguages")
)

// dwFlags (DWORD), pulNumLanguages (DWORD* out), pwszLanguagesBuffer (LPWSTR optional, out), pcchLanguagesBuffer (DWORD* in/out)
r1, _, err := procGetUserPreferredUILanguages.Call(
	uintptr(dwFlags),
	uintptr(pulNumLanguages),
	uintptr(pwszLanguagesBuffer),
	uintptr(pcchLanguagesBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetUserPreferredUILanguages(
  dwFlags: DWORD;   // DWORD
  pulNumLanguages: Pointer;   // DWORD* out
  pwszLanguagesBuffer: PWideChar;   // LPWSTR optional, out
  pcchLanguagesBuffer: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetUserPreferredUILanguages';
result := DllCall("KERNEL32\GetUserPreferredUILanguages"
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pulNumLanguages   ; DWORD* out
    , "Ptr", pwszLanguagesBuffer   ; LPWSTR optional, out
    , "Ptr", pcchLanguagesBuffer   ; DWORD* in/out
    , "Int")   ; return: BOOL
●GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer) = DLL("KERNEL32.dll", "bool GetUserPreferredUILanguages(dword, void*, char*, void*)")
# 呼び出し: GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
# dwFlags : DWORD -> "dword"
# pulNumLanguages : DWORD* out -> "void*"
# pwszLanguagesBuffer : LPWSTR optional, out -> "char*"
# pcchLanguagesBuffer : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetUserPreferredUILanguages(
    dwFlags: u32, // DWORD
    pulNumLanguages: [*c]u32, // DWORD* out
    pwszLanguagesBuffer: [*c]u16, // LPWSTR optional, out
    pcchLanguagesBuffer: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc GetUserPreferredUILanguages(
    dwFlags: uint32,  # DWORD
    pulNumLanguages: ptr uint32,  # DWORD* out
    pwszLanguagesBuffer: ptr uint16,  # LPWSTR optional, out
    pcchLanguagesBuffer: ptr uint32  # DWORD* in/out
): int32 {.importc: "GetUserPreferredUILanguages", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetUserPreferredUILanguages(
    uint dwFlags,   // DWORD
    uint* pulNumLanguages,   // DWORD* out
    wchar* pwszLanguagesBuffer,   // LPWSTR optional, out
    uint* pcchLanguagesBuffer   // DWORD* in/out
);
ccall((:GetUserPreferredUILanguages, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, Ptr{UInt32}, Ptr{UInt16}, Ptr{UInt32}),
      dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
# dwFlags : DWORD -> UInt32
# pulNumLanguages : DWORD* out -> Ptr{UInt32}
# pwszLanguagesBuffer : LPWSTR optional, out -> Ptr{UInt16}
# pcchLanguagesBuffer : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetUserPreferredUILanguages(
    uint32_t dwFlags,
    uint32_t* pulNumLanguages,
    uint16_t* pwszLanguagesBuffer,
    uint32_t* pcchLanguagesBuffer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
-- dwFlags : DWORD
-- pulNumLanguages : DWORD* out
-- pwszLanguagesBuffer : LPWSTR optional, out
-- pcchLanguagesBuffer : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetUserPreferredUILanguages = lib.func('__stdcall', 'GetUserPreferredUILanguages', 'int32_t', ['uint32_t', 'uint32_t *', 'uint16_t *', 'uint32_t *']);
// GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
// dwFlags : DWORD -> 'uint32_t'
// pulNumLanguages : DWORD* out -> 'uint32_t *'
// pwszLanguagesBuffer : LPWSTR optional, out -> 'uint16_t *'
// pcchLanguagesBuffer : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetUserPreferredUILanguages: { parameters: ["u32", "pointer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
// dwFlags : DWORD -> "u32"
// pulNumLanguages : DWORD* out -> "pointer"
// pwszLanguagesBuffer : LPWSTR optional, out -> "buffer"
// pcchLanguagesBuffer : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetUserPreferredUILanguages(
    uint32_t dwFlags,
    uint32_t* pulNumLanguages,
    uint16_t* pwszLanguagesBuffer,
    uint32_t* pcchLanguagesBuffer);
C, "KERNEL32.dll");
// $ffi->GetUserPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer);
// dwFlags : DWORD
// pulNumLanguages : DWORD* out
// pwszLanguagesBuffer : LPWSTR optional, out
// pcchLanguagesBuffer : DWORD* in/out
// 構造体/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);
    boolean GetUserPreferredUILanguages(
        int dwFlags,   // DWORD
        IntByReference pulNumLanguages,   // DWORD* out
        char[] pwszLanguagesBuffer,   // LPWSTR optional, out
        IntByReference pcchLanguagesBuffer   // DWORD* in/out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetUserPreferredUILanguages = GetUserPreferredUILanguages(
    dwFlags : UInt32,   # DWORD
    pulNumLanguages : UInt32*,   # DWORD* out
    pwszLanguagesBuffer : UInt16*,   # LPWSTR optional, out
    pcchLanguagesBuffer : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetUserPreferredUILanguagesNative = Int32 Function(Uint32, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>);
typedef GetUserPreferredUILanguagesDart = int Function(int, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>);
final GetUserPreferredUILanguages = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetUserPreferredUILanguagesNative, GetUserPreferredUILanguagesDart>('GetUserPreferredUILanguages');
// dwFlags : DWORD -> Uint32
// pulNumLanguages : DWORD* out -> Pointer<Uint32>
// pwszLanguagesBuffer : LPWSTR optional, out -> Pointer<Utf16>
// pcchLanguagesBuffer : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetUserPreferredUILanguages(
  dwFlags: DWORD;   // DWORD
  pulNumLanguages: Pointer;   // DWORD* out
  pwszLanguagesBuffer: PWideChar;   // LPWSTR optional, out
  pcchLanguagesBuffer: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetUserPreferredUILanguages';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetUserPreferredUILanguages"
  c_GetUserPreferredUILanguages :: Word32 -> Ptr Word32 -> CWString -> Ptr Word32 -> IO CInt
-- dwFlags : DWORD -> Word32
-- pulNumLanguages : DWORD* out -> Ptr Word32
-- pwszLanguagesBuffer : LPWSTR optional, out -> CWString
-- pcchLanguagesBuffer : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getuserpreferreduilanguages =
  foreign "GetUserPreferredUILanguages"
    (uint32_t @-> (ptr uint32_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* dwFlags : DWORD -> uint32_t *)
(* pulNumLanguages : DWORD* out -> (ptr uint32_t) *)
(* pwszLanguagesBuffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcchLanguagesBuffer : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetUserPreferredUILanguages" get-user-preferred-uilanguages :convention :stdcall) :int32
  (dw-flags :uint32)   ; DWORD
  (pul-num-languages :pointer)   ; DWORD* out
  (pwsz-languages-buffer :pointer)   ; LPWSTR optional, out
  (pcch-languages-buffer :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetUserPreferredUILanguages = Win32::API::More->new('KERNEL32',
    'BOOL GetUserPreferredUILanguages(DWORD dwFlags, LPVOID pulNumLanguages, LPWSTR pwszLanguagesBuffer, LPVOID pcchLanguagesBuffer)');
# my $ret = $GetUserPreferredUILanguages->Call($dwFlags, $pulNumLanguages, $pwszLanguagesBuffer, $pcchLanguagesBuffer);
# dwFlags : DWORD -> DWORD
# pulNumLanguages : DWORD* out -> LPVOID
# pwszLanguagesBuffer : LPWSTR optional, out -> LPWSTR
# pcchLanguagesBuffer : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。