ホーム › Globalization › GetSystemPreferredUILanguages

GetSystemPreferredUILanguages

関数

システムの優先UI言語一覧を取得する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

dwFlags

DWORD

言語形式とフィルタリングを指定するフラグです。次のフラグは、システムの優先 UI 言語に使用する形式を指定します。これらのフラグは相互に排他的で、既定値は MUI_LANGUAGE_NAME です。

Value	Meaning
MUI_LANGUAGE_ID	言語文字列を language identifier 形式で取得します。
MUI_LANGUAGE_NAME	言語文字列を language name 形式で取得します。

次のフラグは、関数が言語の一覧を検証するか(既定)、それともシステムの優先 UI 言語の一覧をレジストリに格納されているとおりに取得するかを指定します。

Value

Meaning

MUI_MACHINE_LANGUAGE_SETTINGS

格納されているシステムの優先 UI 言語の一覧を取得します。各言語名が有効な NLS ロケールに対応しているかどうかのみを確認します。このフラグが設定されていない場合、関数は一覧が空でなく検証基準を満たしている限り、システムの優先 UI 言語を pwszLanguagesBuffer に取得します。それ以外の場合、関数はシステムの既定のユーザーインターフェイス言語を言語バッファーに取得します。

pulNumLanguages

DWORD*

out

pwszLanguagesBuffer に取得された言語の数へのポインターです。

pwszLanguagesBuffer

LPWSTR

outoptional

省略可能です。この関数が、dwFlags で指定された形式で、順序付けされた null 区切りのシステム優先 UI 言語の一覧を取得するバッファーへのポインターです。この一覧は 2 つの null 文字で終わります。

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

pcchLanguagesBuffer

DWORD*

inout

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

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

戻り値の型: BOOL

公式ドキュメント

システムの優先 UI 言語を取得します。詳細については、User Interface Language Management を参照してください。

戻り値

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

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

その他の理由で関数が失敗した場合、パラメーター pulNumLanguages および pcchLanguagesBuffer は未定義です。

解説(Remarks)

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

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

MUI_MACHINE_LANGUAGE_SETTINGS フラグが設定されている場合、この関数は一覧内の各言語が有効な NLS ロケールを表しているかどうかを確認します。取得される一覧には次の項目が含まれる可能性があります。

システムにインストールされていない言語
重複する言語エントリ
空の文字列

MUI_MACHINE_LANGUAGE_SETTINGS フラグが設定されていて、システムの優先 UI 言語の一覧が空の場合、関数は言語バッファーに空の文字列(マルチ文字列バッファーであるため 2 つの null 文字)を、言語の数として 0 を、バッファーサイズとして 2 を取得します。

MUI_MACHINE_LANGUAGE_SETTINGS フラグが設定されていない場合、取得される言語の一覧は次の特性を持ちます。

各言語は有効な NLS ロケールを表します。
各言語はオペレーティングシステムにインストールされています。
一覧には言語ごとに 1 つのエントリが含まれ、重複するエントリはありません。

C# Signature

[DllImport("Kernel32.dll", CharSet = CharSet.Auto)]
        static extern System.Boolean GetSystemPreferredUILanguages(
            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 GetSystemPreferredUILanguages(
    DWORD dwFlags,
    DWORD* pulNumLanguages,
    LPWSTR pwszLanguagesBuffer,   // optional
    DWORD* pcchLanguagesBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetSystemPreferredUILanguages(
    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 GetSystemPreferredUILanguages(
    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 GetSystemPreferredUILanguages 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

GetSystemPreferredUILanguages = ctypes.windll.kernel32.GetSystemPreferredUILanguages
GetSystemPreferredUILanguages.restype = wintypes.BOOL
GetSystemPreferredUILanguages.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')
GetSystemPreferredUILanguages = Fiddle::Function.new(
  lib['GetSystemPreferredUILanguages'],
  [
    -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 GetSystemPreferredUILanguages(
        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 GetSystemPreferredUILanguages(uint dwFlags, out uint pulNumLanguages, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszLanguagesBuffer, ref uint pcchLanguagesBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemPreferredUILanguages' -Namespace Win32 -PassThru
# $api::GetSystemPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)

#uselib "KERNEL32.dll"
#func global GetSystemPreferredUILanguages "GetSystemPreferredUILanguages" sptr, sptr, sptr, sptr
; GetSystemPreferredUILanguages 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 GetSystemPreferredUILanguages "GetSystemPreferredUILanguages" int, var, var, var
; res = GetSystemPreferredUILanguages(dwFlags, pulNumLanguages, pwszLanguagesBuffer, pcchLanguagesBuffer)
; dwFlags : DWORD -> "int"
; pulNumLanguages : DWORD* out -> "var"
; pwszLanguagesBuffer : LPWSTR optional, out -> "var"
; pcchLanguagesBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetSystemPreferredUILanguages "GetSystemPreferredUILanguages" int, sptr, sptr, sptr
; res = GetSystemPreferredUILanguages(dwFlags, varptr(pulNumLanguages), varptr(pwszLanguagesBuffer), varptr(pcchLanguagesBuffer))
; dwFlags : DWORD -> "int"
; pulNumLanguages : DWORD* out -> "sptr"
; pwszLanguagesBuffer : LPWSTR optional, out -> "sptr"
; pcchLanguagesBuffer : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。