Win32 API 日本語リファレンス
ホームUI.Input.KeyboardAndMouse › LoadKeyboardLayoutW

LoadKeyboardLayoutW

関数
キーボードレイアウトを読み込んで有効化する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

HKL LoadKeyboardLayoutW(
    LPCWSTR pwszKLID,
    ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags
);

パラメーター

名前方向説明
pwszKLIDLPCWSTRin

読み込む入力ロケール識別子の名前。この名前は、言語識別子(下位ワード)の16進値とデバイス識別子(上位ワード)で構成される文字列です。例えば、米国英語の言語識別子は 0x0409 なので、基本的な米国英語レイアウトの名前は "00000409" になります。米国英語レイアウトのバリアント(Dvorak レイアウトなど)は "00010409"、"00020409" のように名付けられます。

Windows に付属する入力レイアウトの一覧については、Keyboard Identifiers and Input Method Editors for Windows を参照してください。

FlagsACTIVATE_KEYBOARD_LAYOUT_FLAGSin

入力ロケール識別子をどのように読み込むかを指定します。このパラメーターには、次の値のいずれかを指定できます。

意味
KLF_ACTIVATE
0x00000001
Windows 8 より前: 指定された入力ロケール識別子がまだ読み込まれていない場合、この関数は現在のスレッドに対してその入力ロケール識別子を読み込み、アクティブにします。

Windows 8 以降: 指定された入力ロケール識別子がまだ読み込まれていない場合、この関数はシステムに対してその入力ロケール識別子を読み込み、アクティブにします。

KLF_NOTELLSHELL
0x00000080
Windows 8 より前: 新しい入力ロケール識別子が読み込まれたときに、ShellProc フックプロシージャが HSHELL_LANGUAGE フックコードを受け取らないようにします。この値は通常、アプリケーションが複数の入力ロケール識別子を連続して読み込むときに使用します。最後の入力ロケール識別子を除くすべてにこの値を適用すると、すべての入力ロケール識別子が追加されるまでシェルの処理が遅延されます。

Windows 8 以降: このシナリオでは、最後の入力ロケール識別子がシステム全体に対して設定されます。

KLF_REORDER
0x00000008
Windows 8 より前: 指定された入力ロケール識別子を入力ロケール識別子リストの先頭に移動し、そのロケール識別子を現在のスレッドのアクティブなロケール識別子にします。この値は、KLF_ACTIVATE が指定されていない場合でも入力ロケール識別子リストを並べ替えます。

Windows 8 以降: 指定された入力ロケール識別子を入力ロケール識別子リストの先頭に移動し、そのロケール識別子をシステムのアクティブなロケール識別子にします。この値は、KLF_ACTIVATE が指定されていない場合でも入力ロケール識別子リストを並べ替えます。

KLF_REPLACELANG
0x00000010
新しい入力ロケール識別子が現在の入力ロケール識別子と同じ言語識別子を持つ場合、新しい入力ロケール識別子がその言語の入力ロケール識別子として現在のものを置き換えます。この値が指定されておらず、入力ロケール識別子が同じ言語識別子を持つ場合、現在の入力ロケール識別子は置き換えられず、関数は NULL を返します。
KLF_SUBSTITUTE_OK
0x00000002
指定された入力ロケール識別子を、ユーザーが優先する別のロケールに置き換えます。システムはこのフラグを設定した状態で起動するため、アプリケーションでは常にこのフラグを使用することが推奨されます。置き換えは、レジストリキー HKEY_CURRENT_USER\Keyboard Layout\Substitutes に置き換え用ロケールが明示的に定義されている場合にのみ行われます。例えば、このキーに値名 "00000409" と値 "00010409" が含まれている場合、US レイアウト("00000409")を読み込むと、代わりに United States-Dvorak レイアウト("00010409")が読み込まれます。システムは起動時に KLF_SUBSTITUTE_OK を使用します。ユーザーの設定が選択されるようにするため、すべてのアプリケーションで入力ロケール識別子を読み込む際にこの値を使用することが推奨されます。
KLF_SETFORPROCESS
0x00000100
Windows 8 より前: このフラグは KLF_ACTIVATE と併用する場合にのみ有効です。指定された入力ロケール識別子をプロセス全体に対してアクティブにし、現在のスレッドのフォーカスウィンドウまたはアクティブウィンドウに WM_INPUTLANGCHANGE メッセージを送信します。通常、LoadKeyboardLayout は現在のスレッドに対してのみ入力ロケール識別子をアクティブにします。

Windows 8 以降: このフラグは使用されません。現在のプロセスがキーボードフォーカスを持つウィンドウを所有している場合、LoadKeyboardLayout は常にシステム全体に対して入力ロケール識別子をアクティブにします。

KLF_UNLOADPREVIOUS
このフラグはサポートされていません。代わりに UnloadKeyboardLayout 関数を使用してください。

戻り値の型: HKL

公式ドキュメント

新しい入力ロケール識別子(以前はキーボードレイアウトと呼ばれていたもの)をシステムに読み込みます。(Unicode)

戻り値

型: HKL

関数が成功した場合、戻り値は pwszKLID で指定された名前に対応する入力ロケール識別子です。一致するロケールが利用できない場合、戻り値はシステムの既定の言語になります。

関数が失敗した場合、戻り値は NULL です。これは、レイアウトライブラリがアプリケーションディレクトリから読み込まれた場合に発生することがあります。

拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

入力ロケール識別子は、speech-to-text コンバーター、Input Method Editor (IME)、その他あらゆる形式の入力を包含できるため、キーボードレイアウトよりも広い概念です。

アプリケーションは通常、ある言語の既定の入力ロケール識別子または IME を読み込むことができ、言語識別子の文字列版のみを指定することでこれを行えます。アプリケーションが特定のロケールまたは IME を読み込みたい場合は、レジストリを読み取って LoadKeyboardLayout に渡す特定の入力ロケール識別子を判別する必要があります。この場合、あるロケールの既定の入力ロケール識別子をアクティブにする要求は、最初に一致したものをアクティブにします。特定の IME は、GetKeyboardLayout または LoadKeyboardLayout から返される明示的な入力ロケール識別子を使用してアクティブにする必要があります。

Windows 8 より前: この関数は、現在のプロセスまたはスレッドのレイアウトにのみ影響します。

Windows 8 以降: この関数は、システム全体のレイアウトに影響します。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして LoadKeyboardLayout を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

HKL LoadKeyboardLayoutW(
    LPCWSTR pwszKLID,
    ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr LoadKeyboardLayoutW(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszKLID,   // LPCWSTR
    uint Flags   // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadKeyboardLayoutW(
    <MarshalAs(UnmanagedType.LPWStr)> pwszKLID As String,   ' LPCWSTR
    Flags As UInteger   ' ACTIVATE_KEYBOARD_LAYOUT_FLAGS
) As IntPtr
End Function
' pwszKLID : LPCWSTR
' Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
Declare PtrSafe Function LoadKeyboardLayoutW Lib "user32" ( _
    ByVal pwszKLID As LongPtr, _
    ByVal Flags As Long) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LoadKeyboardLayoutW = ctypes.windll.user32.LoadKeyboardLayoutW
LoadKeyboardLayoutW.restype = ctypes.c_void_p
LoadKeyboardLayoutW.argtypes = [
    wintypes.LPCWSTR,  # pwszKLID : LPCWSTR
    wintypes.DWORD,  # Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LoadKeyboardLayoutW = Fiddle::Function.new(
  lib['LoadKeyboardLayoutW'],
  [
    Fiddle::TYPE_VOIDP,  # pwszKLID : LPCWSTR
    -Fiddle::TYPE_INT,  # Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn LoadKeyboardLayoutW(
        pwszKLID: *const u16,  // LPCWSTR
        Flags: u32  // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr LoadKeyboardLayoutW([MarshalAs(UnmanagedType.LPWStr)] string pwszKLID, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadKeyboardLayoutW' -Namespace Win32 -PassThru
# $api::LoadKeyboardLayoutW(pwszKLID, Flags)
#uselib "USER32.dll"
#func global LoadKeyboardLayoutW "LoadKeyboardLayoutW" wptr, wptr
; LoadKeyboardLayoutW pwszKLID, Flags   ; 戻り値は stat
; pwszKLID : LPCWSTR -> "wptr"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LoadKeyboardLayoutW "LoadKeyboardLayoutW" wstr, int
; res = LoadKeyboardLayoutW(pwszKLID, Flags)
; pwszKLID : LPCWSTR -> "wstr"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "int"
; HKL LoadKeyboardLayoutW(LPCWSTR pwszKLID, ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags)
#uselib "USER32.dll"
#cfunc global LoadKeyboardLayoutW "LoadKeyboardLayoutW" wstr, int
; res = LoadKeyboardLayoutW(pwszKLID, Flags)
; pwszKLID : LPCWSTR -> "wstr"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLoadKeyboardLayoutW = user32.NewProc("LoadKeyboardLayoutW")
)

// pwszKLID (LPCWSTR), Flags (ACTIVATE_KEYBOARD_LAYOUT_FLAGS)
r1, _, err := procLoadKeyboardLayoutW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszKLID))),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HKL
function LoadKeyboardLayoutW(
  pwszKLID: PWideChar;   // LPCWSTR
  Flags: DWORD   // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
): THandle; stdcall;
  external 'USER32.dll' name 'LoadKeyboardLayoutW';
result := DllCall("USER32\LoadKeyboardLayoutW"
    , "WStr", pwszKLID   ; LPCWSTR
    , "UInt", Flags   ; ACTIVATE_KEYBOARD_LAYOUT_FLAGS
    , "Ptr")   ; return: HKL
●LoadKeyboardLayoutW(pwszKLID, Flags) = DLL("USER32.dll", "void* LoadKeyboardLayoutW(char*, dword)")
# 呼び出し: LoadKeyboardLayoutW(pwszKLID, Flags)
# pwszKLID : LPCWSTR -> "char*"
# Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn LoadKeyboardLayoutW(
    pwszKLID: [*c]const u16, // LPCWSTR
    Flags: u32 // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc LoadKeyboardLayoutW(
    pwszKLID: WideCString,  # LPCWSTR
    Flags: uint32  # ACTIVATE_KEYBOARD_LAYOUT_FLAGS
): pointer {.importc: "LoadKeyboardLayoutW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
void* LoadKeyboardLayoutW(
    const(wchar)* pwszKLID,   // LPCWSTR
    uint Flags   // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
);
ccall((:LoadKeyboardLayoutW, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Cwstring, UInt32),
      pwszKLID, Flags)
# pwszKLID : LPCWSTR -> Cwstring
# Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* LoadKeyboardLayoutW(
    const uint16_t* pwszKLID,
    uint32_t Flags);
]]
local user32 = ffi.load("user32")
-- user32.LoadKeyboardLayoutW(pwszKLID, Flags)
-- pwszKLID : LPCWSTR
-- Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadKeyboardLayoutW = lib.func('__stdcall', 'LoadKeyboardLayoutW', 'void *', ['str16', 'uint32_t']);
// LoadKeyboardLayoutW(pwszKLID, Flags)
// pwszKLID : LPCWSTR -> 'str16'
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LoadKeyboardLayoutW: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.LoadKeyboardLayoutW(pwszKLID, Flags)
// pwszKLID : LPCWSTR -> "buffer"
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LoadKeyboardLayoutW(
    const uint16_t* pwszKLID,
    uint32_t Flags);
C, "USER32.dll");
// $ffi->LoadKeyboardLayoutW(pwszKLID, Flags);
// pwszKLID : LPCWSTR
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
// 構造体/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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer LoadKeyboardLayoutW(
        WString pwszKLID,   // LPCWSTR
        int Flags   // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun LoadKeyboardLayoutW = LoadKeyboardLayoutW(
    pwszKLID : UInt16*,   # LPCWSTR
    Flags : UInt32   # ACTIVATE_KEYBOARD_LAYOUT_FLAGS
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LoadKeyboardLayoutWNative = Pointer<Void> Function(Pointer<Utf16>, Uint32);
typedef LoadKeyboardLayoutWDart = Pointer<Void> Function(Pointer<Utf16>, int);
final LoadKeyboardLayoutW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<LoadKeyboardLayoutWNative, LoadKeyboardLayoutWDart>('LoadKeyboardLayoutW');
// pwszKLID : LPCWSTR -> Pointer<Utf16>
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadKeyboardLayoutW(
  pwszKLID: PWideChar;   // LPCWSTR
  Flags: DWORD   // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
): THandle; stdcall;
  external 'USER32.dll' name 'LoadKeyboardLayoutW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LoadKeyboardLayoutW"
  c_LoadKeyboardLayoutW :: CWString -> Word32 -> IO (Ptr ())
-- pwszKLID : LPCWSTR -> CWString
-- Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let loadkeyboardlayoutw =
  foreign "LoadKeyboardLayoutW"
    ((ptr uint16_t) @-> uint32_t @-> returning (ptr void))
(* pwszKLID : LPCWSTR -> (ptr uint16_t) *)
(* Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("LoadKeyboardLayoutW" load-keyboard-layout-w :convention :stdcall) :pointer
  (pwsz-klid (:string :encoding :utf-16le))   ; LPCWSTR
  (flags :uint32))   ; ACTIVATE_KEYBOARD_LAYOUT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LoadKeyboardLayoutW = Win32::API::More->new('USER32',
    'HANDLE LoadKeyboardLayoutW(LPCWSTR pwszKLID, DWORD Flags)');
# my $ret = $LoadKeyboardLayoutW->Call($pwszKLID, $Flags);
# pwszKLID : LPCWSTR -> LPCWSTR
# Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型