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

GetKeyboardLayoutNameW

関数
現在のキーボードレイアウト名を取得する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetKeyboardLayoutNameW(
    LPWSTR pwszKLID
);

パラメーター

名前方向説明
pwszKLIDLPWSTRout

入力ロケール識別子の名前を、終端の null 文字を含めて受け取るバッファー(少なくとも KL_NAMELENGTH 文字分の長さが必要)です。これは、レイアウト置換が行われた場合を除き、LoadKeyboardLayout 関数に渡された文字列のコピーになります。

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

戻り値の型: BOOL

公式ドキュメント

呼び出し元スレッドのアクティブな入力ロケール識別子(以前はキーボード レイアウトと呼ばれていたもの)の名前を取得します。(Unicode)

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

入力ロケール識別子はキーボード レイアウトよりも広い概念であり、音声テキスト変換、Input Method Editor (IME)、その他あらゆる形式の入力を含むことができます。

Windows 8 以降: 現在のキーボード レイアウトまたは入力方式に関連付けられた言語を取得する推奨される方法は、Windows.Globalization.Language.CurrentInputMethodLanguageTag の呼び出しです。アプリが CurrentInputMethodLanguageTag から取得した言語タグを National Language Support 関数に渡す場合は、まず ResolveLocaleName を呼び出してタグを変換する必要があります。

メモ

winuser.h ヘッダーは GetKeyboardLayoutName を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードとを混在させると、不一致が生じてコンパイル エラーや実行時エラーの原因となることがあります。詳細については、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>

BOOL GetKeyboardLayoutNameW(
    LPWSTR pwszKLID
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetKeyboardLayoutNameW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszKLID   // LPWSTR out
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetKeyboardLayoutNameW(
    <MarshalAs(UnmanagedType.LPWStr)> pwszKLID As System.Text.StringBuilder   ' LPWSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pwszKLID : LPWSTR out
Declare PtrSafe Function GetKeyboardLayoutNameW Lib "user32" ( _
    ByVal pwszKLID As LongPtr) As Long
' 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

GetKeyboardLayoutNameW = ctypes.windll.user32.GetKeyboardLayoutNameW
GetKeyboardLayoutNameW.restype = wintypes.BOOL
GetKeyboardLayoutNameW.argtypes = [
    wintypes.LPWSTR,  # pwszKLID : LPWSTR out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetKeyboardLayoutNameW = Fiddle::Function.new(
  lib['GetKeyboardLayoutNameW'],
  [
    Fiddle::TYPE_VOIDP,  # pwszKLID : LPWSTR out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn GetKeyboardLayoutNameW(
        pwszKLID: *mut u16  // LPWSTR out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetKeyboardLayoutNameW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszKLID);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetKeyboardLayoutNameW' -Namespace Win32 -PassThru
# $api::GetKeyboardLayoutNameW(pwszKLID)
#uselib "USER32.dll"
#func global GetKeyboardLayoutNameW "GetKeyboardLayoutNameW" wptr
; GetKeyboardLayoutNameW varptr(pwszKLID)   ; 戻り値は stat
; pwszKLID : LPWSTR out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetKeyboardLayoutNameW "GetKeyboardLayoutNameW" var
; res = GetKeyboardLayoutNameW(pwszKLID)
; pwszKLID : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetKeyboardLayoutNameW(LPWSTR pwszKLID)
#uselib "USER32.dll"
#cfunc global GetKeyboardLayoutNameW "GetKeyboardLayoutNameW" var
; res = GetKeyboardLayoutNameW(pwszKLID)
; pwszKLID : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetKeyboardLayoutNameW = user32.NewProc("GetKeyboardLayoutNameW")
)

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

extern "user32" fn GetKeyboardLayoutNameW(
    pwszKLID: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetKeyboardLayoutNameW(
    pwszKLID: ptr uint16  # LPWSTR out
): int32 {.importc: "GetKeyboardLayoutNameW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int GetKeyboardLayoutNameW(
    wchar* pwszKLID   // LPWSTR out
);
ccall((:GetKeyboardLayoutNameW, "USER32.dll"), stdcall, Int32,
      (Ptr{UInt16},),
      pwszKLID)
# pwszKLID : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetKeyboardLayoutNameW(
    uint16_t* pwszKLID);
]]
local user32 = ffi.load("user32")
-- user32.GetKeyboardLayoutNameW(pwszKLID)
-- pwszKLID : LPWSTR out
-- 構造体/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 GetKeyboardLayoutNameW = lib.func('__stdcall', 'GetKeyboardLayoutNameW', 'int32_t', ['uint16_t *']);
// GetKeyboardLayoutNameW(pwszKLID)
// pwszKLID : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetKeyboardLayoutNameW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.GetKeyboardLayoutNameW(pwszKLID)
// pwszKLID : LPWSTR out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetKeyboardLayoutNameW(
    uint16_t* pwszKLID);
C, "USER32.dll");
// $ffi->GetKeyboardLayoutNameW(pwszKLID);
// pwszKLID : LPWSTR out
// 構造体/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);
    boolean GetKeyboardLayoutNameW(
        char[] pwszKLID   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun GetKeyboardLayoutNameW = GetKeyboardLayoutNameW(
    pwszKLID : UInt16*   # LPWSTR out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetKeyboardLayoutNameWNative = Int32 Function(Pointer<Utf16>);
typedef GetKeyboardLayoutNameWDart = int Function(Pointer<Utf16>);
final GetKeyboardLayoutNameW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetKeyboardLayoutNameWNative, GetKeyboardLayoutNameWDart>('GetKeyboardLayoutNameW');
// pwszKLID : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetKeyboardLayoutNameW(
  pwszKLID: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetKeyboardLayoutNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetKeyboardLayoutNameW"
  c_GetKeyboardLayoutNameW :: CWString -> IO CInt
-- pwszKLID : LPWSTR out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getkeyboardlayoutnamew =
  foreign "GetKeyboardLayoutNameW"
    ((ptr uint16_t) @-> returning int32_t)
(* pwszKLID : LPWSTR out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

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

関連項目

文字セット違い
公式の関連項目