GetUILanguageInfo

関数

指定UI言語のフォールバック言語と属性情報を取得する。

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

シグネチャ

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

BOOL GetUILanguageInfo(
    DWORD dwFlags,
    LPCWSTR pwmszLanguage,
    LPWSTR pwszFallbackLanguages,   // optional
    DWORD* pcchFallbackLanguages,   // optional
    DWORD* pAttributes
);

パラメーター

名前

型

方向

説明

dwFlags

DWORD

指定する言語の形式を定義するフラグです。これらのフラグは相互排他的で、既定値は MUI_LANGUAGE_NAME です。

値	意味
MUI_LANGUAGE_ID	言語文字列を言語識別子形式で取得します。
MUI_LANGUAGE_NAME	言語文字列を言語名形式で取得します。

pwmszLanguage

LPCWSTR

この関数が情報を取得する対象の言語へのポインターです。このパラメーターは、フラグ設定に応じて、言語識別子または言語名を null 区切りで順序付けたリストを示します。このパラメーターの使い方については、「解説」のセクションを参照してください。

pwszFallbackLanguages

LPWSTR

outoptional

この関数が、dwFlags の設定で定義された形式で、順序付けされ null 区切りのフォールバック言語リストを取得するバッファーへのポインターです。このリストは 2 つの null 文字で終わります。

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

pcchFallbackLanguages

DWORD*

inoutoptional

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

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

pAttributes

DWORD*

out

入力された言語リストの属性を示すフラグへのポインターです。この関数は常に、リストの最後に挙げられた言語を特徴づけるフラグを取得します。

値	意味
MUI_FULL_LANGUAGE	その言語は完全にローカライズされています。
MUI_PARTIAL_LANGUAGE	その言語は部分的にローカライズされています。
MUI_LIP_LANGUAGE	その言語は LIP 言語です。

さらに pdwAttributes には、必要に応じて次のフラグの一方または両方が含まれます。

値	意味
MUI_LANGUAGE_INSTALLED	その言語はこのコンピューターにインストールされています。
MUI_LANGUAGE_LICENSED	その言語は現在のユーザーに対して適切にライセンスされています。

戻り値の型: BOOL

公式ドキュメント

インストール済みの UI 言語に関するさまざまな情報を取得します

戻り値

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

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分に大きくなかったか、誤って NULL に設定されていました。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。詳細については「解説」を参照してください。
ERROR_OBJECT_NAME_NOT_FOUND。指定されたオブジェクト名が見つからなかったか、無効であったか、または入力リストの最初の言語がインストール済みの言語ではありませんでした。詳細については「解説」を参照してください。

GetLastError がそれ以外のエラーコードを返した場合、パラメーター pcchFallbackLanguages および pdwAttributes は未定義です。

解説(Remarks)

MUI_LANGUAGE_NAME は MUI_LANGUAGE_ID よりも推奨されます。これは、定義済みのロケールに対応せず、代わりに補助ロケールに対応する LIP 言語を、関数がより適切に処理できるためです。定義済みのロケールに対応する LIP 言語は、LIP 言語以外と同様に処理されます。

MUI_LANGUAGE_ID フラグを指定する場合、与える言語文字列は

先頭の 0x を含まない 16 進の言語識別子で、長さは 4 文字でなければなりません。

たとえば、en-US は "0409"、en は "0009" として渡します。返される言語文字列も

同じ形式になります。

MUI_LANGUAGE_ID を指定した場合、ユーザー優先 UI 言語リストにそのような言語が存在するときは、リスト内にそのような言語は 1 つだけしか存在できません。その言語は、LOCALE_CUSTOM_UI_DEFAULT の 16 進値に対応する "1400" として pwmszLanguage に指定できます。MUI_LANGUAGE_ID を使用して、それ以外のそのような言語を指定することはできません。pwmszLanguage が示す文字列内で、LOCALE_CUSTOM_UNSPECIFIED の 16 進値に対応する "1000" を使用すると、ERROR_INVALID_PARAMETER コードが返されます。

部分的にローカライズされた言語は、部分的にローカライズされたフォールバック言語を持つことがあり、その場合は完全な情報を得るために GetUILanguageInfo を繰り返し呼び出す必要があります。部分的にローカライズされた言語 Lang1 が 3 つのフォールバック言語の選択肢を提供する場合を考えます。フォールバック言語 Lang3 は部分的にローカライズされており、2 つのフォールバック言語の選択肢を提供します。依存関係は次のとおりで、既定のフォールバックが先頭に挙げられています。

Lang1
- Lang2
- Lang3
  - Lang5
  - Lang6
- Lang4

Lang1 のフォールバック言語を取得するには、アプリケーションは pwmszLanguage として "Lang1\0\0" を渡します。関数から返ると、pwszFallbackLanguages には "Lang2\0Lang3\0Lang4\0\0" が設定されます。このリストの順序は、Lang2 が既定のフォールバック言語であることを示している点に注意してください。

Lang1 に対する Lang3 のフォールバック言語を取得するには、アプリケーションは pwmszLanguage として "lang1\0\lang3\0\0" を渡します。関数から返ると、pwszFallbackLanguages には "Lang5\0Lang6\0\0" が設定されます。

この関数は、次のいずれかの場合に ERROR_INVALID_PARAMETER を返します。

pwmszLanguage が NULL または空である。
MUI_LANGUAGE_ID と MUI_LANGUAGE_NAME の両方が設定されている。
MUI_LANGUAGE_ID または MUI_LANGUAGE_NAME 以外のフラグが設定されている。
pcchFallbackLanguages が 0 より大きいが、pwszFallbackLanguages が NULL である。
フラグ設定に応じて、pwmszLanguage を言語識別子または言語名のマルチ文字列バッファーとして解析できない。

ERROR_OBJECT_NAME_NOT_FOUND エラーコードは、pwmszLanguage を解析できるが無効である場合に発生します。このコードは、無効なロケール識別子の場合、入力リストの最初の言語がインストール済みの言語でない場合、または完全にローカライズされた言語がフォールバック言語を定義している場合にも返されることがあります。

C# シグネチャ

[DllImport("Kernel32.dll", CharSet = CharSet.Auto)]
        static extern System.Boolean GetUILanguageInfo(
            System.UInt32 dwFlags,
            System.String pwmszLanguage,
            System.IntPtr pwszFallbackLanguages,
            ref System.UInt32 pcchFallbackLanguages,
            ref System.UInt32 pdwAttributes
            );

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

各言語での呼び出し定義

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

BOOL GetUILanguageInfo(
    DWORD dwFlags,
    LPCWSTR pwmszLanguage,
    LPWSTR pwszFallbackLanguages,   // optional
    DWORD* pcchFallbackLanguages,   // optional
    DWORD* pAttributes
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetUILanguageInfo(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pwmszLanguage,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszFallbackLanguages,   // LPWSTR optional, out
    IntPtr pcchFallbackLanguages,   // DWORD* optional, in/out
    out uint pAttributes   // DWORD* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUILanguageInfo(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwmszLanguage As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwszFallbackLanguages As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchFallbackLanguages As IntPtr,   ' DWORD* optional, in/out
    <Out> ByRef pAttributes As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwFlags : DWORD
' pwmszLanguage : LPCWSTR
' pwszFallbackLanguages : LPWSTR optional, out
' pcchFallbackLanguages : DWORD* optional, in/out
' pAttributes : DWORD* out
Declare PtrSafe Function GetUILanguageInfo Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal pwmszLanguage As LongPtr, _
    ByVal pwszFallbackLanguages As LongPtr, _
    ByVal pcchFallbackLanguages As LongPtr, _
    ByRef pAttributes As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetUILanguageInfo = ctypes.windll.kernel32.GetUILanguageInfo
GetUILanguageInfo.restype = wintypes.BOOL
GetUILanguageInfo.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # pwmszLanguage : LPCWSTR
    wintypes.LPWSTR,  # pwszFallbackLanguages : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchFallbackLanguages : DWORD* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # pAttributes : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetUILanguageInfo = Fiddle::Function.new(
  lib['GetUILanguageInfo'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pwmszLanguage : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pwszFallbackLanguages : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchFallbackLanguages : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pAttributes : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetUILanguageInfo(
        dwFlags: u32,  // DWORD
        pwmszLanguage: *const u16,  // LPCWSTR
        pwszFallbackLanguages: *mut u16,  // LPWSTR optional, out
        pcchFallbackLanguages: *mut u32,  // DWORD* optional, in/out
        pAttributes: *mut u32  // DWORD* 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 GetUILanguageInfo(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pwmszLanguage, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszFallbackLanguages, IntPtr pcchFallbackLanguages, out uint pAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetUILanguageInfo' -Namespace Win32 -PassThru
# $api::GetUILanguageInfo(dwFlags, pwmszLanguage, pwszFallbackLanguages, pcchFallbackLanguages, pAttributes)

#uselib "KERNEL32.dll"
#func global GetUILanguageInfo "GetUILanguageInfo" sptr, sptr, sptr, sptr, sptr
; GetUILanguageInfo dwFlags, pwmszLanguage, varptr(pwszFallbackLanguages), varptr(pcchFallbackLanguages), varptr(pAttributes)   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; pwmszLanguage : LPCWSTR -> "sptr"
; pwszFallbackLanguages : LPWSTR optional, out -> "sptr"
; pcchFallbackLanguages : DWORD* optional, in/out -> "sptr"
; pAttributes : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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