LoadKeyboardLayoutA
関数シグネチャ
// USER32.dll (ANSI / -A)
#include <windows.h>
HKL LoadKeyboardLayoutA(
LPCSTR pwszKLID,
ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| pwszKLID | LPCSTR | in | 読み込む入力ロケール識別子の名前。この名前は、言語識別子(下位ワード)の16進値とデバイス識別子(上位ワード)から構成される文字列です。たとえば米国英語の言語識別子は0x0409なので、主要な米国英語レイアウトの名前は "00000409" となります。米国英語レイアウトのバリエーション(Dvorakレイアウトなど)は "00010409"、"00020409" のように名付けられます。 Windowsに付属する入力レイアウトの一覧については、「Keyboard Identifiers and Input Method Editors for Windows」を参照してください。 | ||||||||||||||||
| Flags | ACTIVATE_KEYBOARD_LAYOUT_FLAGS | in | 入力ロケール識別子をどのように読み込むかを指定します。このパラメーターには、次の値を1つ以上指定できます。
|
戻り値の型: HKL
公式ドキュメント
新しい入力ロケール識別子(以前はキーボードレイアウトと呼ばれていたもの)をシステムに読み込みます。(ANSI)
戻り値
型: HKL
関数が成功すると、戻り値は pwszKLID で指定した名前に対応する入力ロケール識別子です。一致するロケールが利用できない場合、戻り値はシステムの既定の言語になります。
関数が失敗すると、戻り値はNULLになります。これは、レイアウトライブラリがアプリケーションディレクトリから読み込まれた場合に発生することがあります。
拡張エラー情報を取得するには、GetLastError を呼び出してください。
解説(Remarks)
入力ロケール識別子は、音声テキスト変換ツール、Input Method Editor(IME)、その他あらゆる形式の入力も包含できるため、キーボードレイアウトよりも広い概念です。
アプリケーションは通常、ある言語の既定の入力ロケール識別子またはIMEを読み込むことができ、また実際にそうします。これは言語識別子の文字列版のみを指定することで行えます。アプリケーションが特定のロケールまたはIMEを読み込みたい場合は、レジストリを読み取って LoadKeyboardLayout に渡す具体的な入力ロケール識別子を判別する必要があります。この場合、あるロケールの既定の入力ロケール識別子をアクティブ化する要求は、最初に一致したものをアクティブ化します。特定のIMEは、GetKeyboardLayout または LoadKeyboardLayout から返される明示的な入力ロケール識別子を使用してアクティブ化する必要があります。
Windows 8より前: この関数は現在のプロセスまたはスレッドのレイアウトにのみ影響します。
Windows 8以降: この関数はシステム全体のレイアウトに影響します。
winuser.h ヘッダーは、LoadKeyboardLayout を、UNICODE プリプロセッサ定数の定義に基づいてこの関数のANSI版とUnicode版を自動的に選択するエイリアスとして定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (ANSI / -A)
#include <windows.h>
HKL LoadKeyboardLayoutA(
LPCSTR pwszKLID,
ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags
);[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr LoadKeyboardLayoutA(
[MarshalAs(UnmanagedType.LPStr)] string pwszKLID, // LPCSTR
uint Flags // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
);<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadKeyboardLayoutA(
<MarshalAs(UnmanagedType.LPStr)> pwszKLID As String, ' LPCSTR
Flags As UInteger ' ACTIVATE_KEYBOARD_LAYOUT_FLAGS
) As IntPtr
End Function' pwszKLID : LPCSTR
' Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
Declare PtrSafe Function LoadKeyboardLayoutA Lib "user32" ( _
ByVal pwszKLID As String, _
ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
LoadKeyboardLayoutA = ctypes.windll.user32.LoadKeyboardLayoutA
LoadKeyboardLayoutA.restype = ctypes.c_void_p
LoadKeyboardLayoutA.argtypes = [
wintypes.LPCSTR, # pwszKLID : LPCSTR
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')
LoadKeyboardLayoutA = Fiddle::Function.new(
lib['LoadKeyboardLayoutA'],
[
Fiddle::TYPE_VOIDP, # pwszKLID : LPCSTR
-Fiddle::TYPE_INT, # Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
],
Fiddle::TYPE_VOIDP)#[link(name = "user32")]
extern "system" {
fn LoadKeyboardLayoutA(
pwszKLID: *const u8, // LPCSTR
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.Ansi, SetLastError = true)]
public static extern IntPtr LoadKeyboardLayoutA([MarshalAs(UnmanagedType.LPStr)] string pwszKLID, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadKeyboardLayoutA' -Namespace Win32 -PassThru
# $api::LoadKeyboardLayoutA(pwszKLID, Flags)#uselib "USER32.dll"
#func global LoadKeyboardLayoutA "LoadKeyboardLayoutA" sptr, sptr
; LoadKeyboardLayoutA pwszKLID, Flags ; 戻り値は stat
; pwszKLID : LPCSTR -> "sptr"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global LoadKeyboardLayoutA "LoadKeyboardLayoutA" str, int
; res = LoadKeyboardLayoutA(pwszKLID, Flags)
; pwszKLID : LPCSTR -> "str"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "int"; HKL LoadKeyboardLayoutA(LPCSTR pwszKLID, ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags)
#uselib "USER32.dll"
#cfunc global LoadKeyboardLayoutA "LoadKeyboardLayoutA" str, int
; res = LoadKeyboardLayoutA(pwszKLID, Flags)
; pwszKLID : LPCSTR -> "str"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procLoadKeyboardLayoutA = user32.NewProc("LoadKeyboardLayoutA")
)
// pwszKLID (LPCSTR), Flags (ACTIVATE_KEYBOARD_LAYOUT_FLAGS)
r1, _, err := procLoadKeyboardLayoutA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pwszKLID))),
uintptr(Flags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HKLfunction LoadKeyboardLayoutA(
pwszKLID: PAnsiChar; // LPCSTR
Flags: DWORD // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
): THandle; stdcall;
external 'USER32.dll' name 'LoadKeyboardLayoutA';result := DllCall("USER32\LoadKeyboardLayoutA"
, "AStr", pwszKLID ; LPCSTR
, "UInt", Flags ; ACTIVATE_KEYBOARD_LAYOUT_FLAGS
, "Ptr") ; return: HKL●LoadKeyboardLayoutA(pwszKLID, Flags) = DLL("USER32.dll", "void* LoadKeyboardLayoutA(char*, dword)")
# 呼び出し: LoadKeyboardLayoutA(pwszKLID, Flags)
# pwszKLID : LPCSTR -> "char*"
# Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn LoadKeyboardLayoutA(
pwszKLID: [*c]const u8, // LPCSTR
Flags: u32 // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc LoadKeyboardLayoutA(
pwszKLID: cstring, # LPCSTR
Flags: uint32 # ACTIVATE_KEYBOARD_LAYOUT_FLAGS
): pointer {.importc: "LoadKeyboardLayoutA", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
void* LoadKeyboardLayoutA(
const(char)* pwszKLID, // LPCSTR
uint Flags // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
);ccall((:LoadKeyboardLayoutA, "USER32.dll"), stdcall, Ptr{Cvoid},
(Cstring, UInt32),
pwszKLID, Flags)
# pwszKLID : LPCSTR -> Cstring
# Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* LoadKeyboardLayoutA(
const char* pwszKLID,
uint32_t Flags);
]]
local user32 = ffi.load("user32")
-- user32.LoadKeyboardLayoutA(pwszKLID, Flags)
-- pwszKLID : LPCSTR
-- Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadKeyboardLayoutA = lib.func('__stdcall', 'LoadKeyboardLayoutA', 'void *', ['str', 'uint32_t']);
// LoadKeyboardLayoutA(pwszKLID, Flags)
// pwszKLID : LPCSTR -> 'str'
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
LoadKeyboardLayoutA: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.LoadKeyboardLayoutA(pwszKLID, Flags)
// pwszKLID : LPCSTR -> "buffer"
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* LoadKeyboardLayoutA(
const char* pwszKLID,
uint32_t Flags);
C, "USER32.dll");
// $ffi->LoadKeyboardLayoutA(pwszKLID, Flags);
// pwszKLID : LPCSTR
// 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.ASCII_OPTIONS);
Pointer LoadKeyboardLayoutA(
String pwszKLID, // LPCSTR
int Flags // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
);
}@[Link("user32")]
lib LibUSER32
fun LoadKeyboardLayoutA = LoadKeyboardLayoutA(
pwszKLID : UInt8*, # LPCSTR
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 LoadKeyboardLayoutANative = Pointer<Void> Function(Pointer<Utf8>, Uint32);
typedef LoadKeyboardLayoutADart = Pointer<Void> Function(Pointer<Utf8>, int);
final LoadKeyboardLayoutA = DynamicLibrary.open('USER32.dll')
.lookupFunction<LoadKeyboardLayoutANative, LoadKeyboardLayoutADart>('LoadKeyboardLayoutA');
// pwszKLID : LPCSTR -> Pointer<Utf8>
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function LoadKeyboardLayoutA(
pwszKLID: PAnsiChar; // LPCSTR
Flags: DWORD // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
): THandle; stdcall;
external 'USER32.dll' name 'LoadKeyboardLayoutA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "LoadKeyboardLayoutA"
c_LoadKeyboardLayoutA :: CString -> Word32 -> IO (Ptr ())
-- pwszKLID : LPCSTR -> CString
-- Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let loadkeyboardlayouta =
foreign "LoadKeyboardLayoutA"
(string @-> uint32_t @-> returning (ptr void))
(* pwszKLID : LPCSTR -> string *)
(* 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 ("LoadKeyboardLayoutA" load-keyboard-layout-a :convention :stdcall) :pointer
(pwsz-klid :string) ; LPCSTR
(flags :uint32)) ; ACTIVATE_KEYBOARD_LAYOUT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $LoadKeyboardLayoutA = Win32::API::More->new('USER32',
'HANDLE LoadKeyboardLayoutA(LPCSTR pwszKLID, DWORD Flags)');
# my $ret = $LoadKeyboardLayoutA->Call($pwszKLID, $Flags);
# pwszKLID : LPCSTR -> LPCSTR
# Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f LoadKeyboardLayoutW (Unicode版) — キーボードレイアウトを読み込んで有効化する(Unicode版)。
- f ActivateKeyboardLayout — 指定したキーボードレイアウトをアクティブにする。
- f GetKeyboardLayoutNameA — 現在のキーボードレイアウト名を取得する(ANSI版)。
- f UnloadKeyboardLayout — 読み込み済みのキーボードレイアウトを解放する。