ホーム › Globalization › SetProcessPreferredUILanguages

SetProcessPreferredUILanguages

関数

プロセスの優先UI言語一覧を設定する。

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

シグネチャ

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

BOOL SetProcessPreferredUILanguages(
    DWORD dwFlags,
    LPCWSTR pwszLanguagesBuffer,   // optional
    DWORD* pulNumLanguages   // optional
);

パラメーター

名前

型

方向

説明

dwFlags

DWORD

プロセスの優先 UI 言語に使用する言語形式を識別するフラグです。これらのフラグは相互排他的であり、既定値は MUI_LANGUAGE_NAME です。

MUI_LANGUAGE_ID ではなく MUI_LANGUAGE_NAME の使用を推奨します。

値	意味
MUI_LANGUAGE_ID	入力パラメーターの言語文字列が language identifier 形式であることを示します。
MUI_LANGUAGE_NAME	入力パラメーターの言語文字列が language name 形式であることを示します。

pwszLanguagesBuffer

LPCWSTR

inoptional

優先度の高い順に並べられ、null で区切られたリストを格納する、二重 null 終端のマルチ文字列バッファーへのポインターです。バッファーに 6 つ以上の言語が含まれている場合、この関数は最初の 5 つの有効な言語のみを設定します。

あるいは、言語リストが不要な場合はこのパラメーターに NULL を指定できます。その場合、この関数はプロセスの優先 UI 言語をクリアします。

pulNumLanguages

DWORD*

outoptional

入力バッファーからプロセスの言語リストに設定された言語の数(最大 5 つ)を格納するポインターです。

戻り値の型: BOOL

公式ドキュメント

アプリケーションのプロセスに対して、プロセスの優先 UI 言語を設定します。詳細については、User Interface Language Management を参照してください。

戻り値

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

ERROR_INVALID_PARAMETER。無効なパラメーターが指定されました。

プロセスの優先 UI 言語リストが空の場合、またはプロセスに指定された言語が有効でない場合、この関数は成功し、pulNumLanguages パラメーターに 0 を設定します。

解説(Remarks)

アプリケーションは、起動後できるだけ早く SetProcessPreferredUILanguages を呼び出すことが理想的です。

この関数が戻った後、アプリケーションは GetProcessPreferredUILanguages を呼び出して、結果として得られた言語リストを検証および確認できます。

MUI_LANGUAGE_ID を指定する場合、入力パラメーターの言語文字列には、先頭の 0x を含まない、長さ 4 文字の 16 進数の言語

識別子を使用する必要があります。たとえば、en-US は "0409" として、en は "0009" として

渡します。

注意 MUI_LANGUAGE_ID よりも MUI_LANGUAGE_NAME の使用を推奨します。

C# シグネチャ

[DllImport("Kernel32.dll", CharSet = CharSet.Auto)]
        static extern System.Boolean SetProcessPreferredUILanguages(
            System.UInt32 dwFlags,
            System.String pwszLanguagesBuffer,
            ref System.UInt32 pulNumLanguages
            );

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

各言語での呼び出し定義

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

BOOL SetProcessPreferredUILanguages(
    DWORD dwFlags,
    LPCWSTR pwszLanguagesBuffer,   // optional
    DWORD* pulNumLanguages   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetProcessPreferredUILanguages(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pwszLanguagesBuffer,   // LPCWSTR optional
    IntPtr pulNumLanguages   // DWORD* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetProcessPreferredUILanguages(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwszLanguagesBuffer As String,   ' LPCWSTR optional
    pulNumLanguages As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwFlags : DWORD
' pwszLanguagesBuffer : LPCWSTR optional
' pulNumLanguages : DWORD* optional, out
Declare PtrSafe Function SetProcessPreferredUILanguages Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal pwszLanguagesBuffer As LongPtr, _
    ByVal pulNumLanguages As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetProcessPreferredUILanguages = ctypes.windll.kernel32.SetProcessPreferredUILanguages
SetProcessPreferredUILanguages.restype = wintypes.BOOL
SetProcessPreferredUILanguages.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # pwszLanguagesBuffer : LPCWSTR optional
    ctypes.POINTER(wintypes.DWORD),  # pulNumLanguages : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetProcessPreferredUILanguages = Fiddle::Function.new(
  lib['SetProcessPreferredUILanguages'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pwszLanguagesBuffer : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pulNumLanguages : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetProcessPreferredUILanguages(
        dwFlags: u32,  // DWORD
        pwszLanguagesBuffer: *const u16,  // LPCWSTR optional
        pulNumLanguages: *mut u32  // DWORD* optional, 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 SetProcessPreferredUILanguages(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pwszLanguagesBuffer, IntPtr pulNumLanguages);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetProcessPreferredUILanguages' -Namespace Win32 -PassThru
# $api::SetProcessPreferredUILanguages(dwFlags, pwszLanguagesBuffer, pulNumLanguages)

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

出力引数:

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