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

GetKeyboardLayoutNameA

関数
現在のキーボードレイアウト名を取得する(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetKeyboardLayoutNameA(
    LPSTR pwszKLID
);

パラメーター

名前型方向説明
pwszKLIDLPSTRout

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

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

戻り値の型: BOOL

公式ドキュメント

呼び出し元スレッドのアクティブな入力ロケール識別子(旧称: キーボードレイアウト)の名前を取得します。(ANSI)

戻り値

型: 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  (ANSI / -A)
#include <windows.h>

BOOL GetKeyboardLayoutNameA(
    LPSTR pwszKLID
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetKeyboardLayoutNameA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pwszKLID   // LPSTR out
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetKeyboardLayoutNameA(
    <MarshalAs(UnmanagedType.LPStr)> pwszKLID As System.Text.StringBuilder   ' LPSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pwszKLID : LPSTR out
Declare PtrSafe Function GetKeyboardLayoutNameA Lib "user32" ( _
    ByVal pwszKLID As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetKeyboardLayoutNameA = user32.NewProc("GetKeyboardLayoutNameA")
)

// pwszKLID (LPSTR out)
r1, _, err := procGetKeyboardLayoutNameA.Call(
	uintptr(pwszKLID),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetKeyboardLayoutNameA(
  pwszKLID: PAnsiChar   // LPSTR out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetKeyboardLayoutNameA';
result := DllCall("USER32\GetKeyboardLayoutNameA"
    , "Ptr", pwszKLID   ; LPSTR out
    , "Int")   ; return: BOOL
●GetKeyboardLayoutNameA(pwszKLID) = DLL("USER32.dll", "bool GetKeyboardLayoutNameA(char*)")
# 呼び出し: GetKeyboardLayoutNameA(pwszKLID)
# pwszKLID : LPSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetKeyboardLayoutNameA(
    pwszKLID: [*c]u8 // LPSTR out
) callconv(std.os.windows.WINAPI) i32;
proc GetKeyboardLayoutNameA(
    pwszKLID: ptr char  # LPSTR out
): int32 {.importc: "GetKeyboardLayoutNameA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int GetKeyboardLayoutNameA(
    char* pwszKLID   // LPSTR out
);
ccall((:GetKeyboardLayoutNameA, "USER32.dll"), stdcall, Int32,
      (Ptr{UInt8},),
      pwszKLID)
# pwszKLID : LPSTR out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetKeyboardLayoutNameA(
    char* pwszKLID);
]]
local user32 = ffi.load("user32")
-- user32.GetKeyboardLayoutNameA(pwszKLID)
-- pwszKLID : LPSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetKeyboardLayoutNameA = lib.func('__stdcall', 'GetKeyboardLayoutNameA', 'int32_t', ['char *']);
// GetKeyboardLayoutNameA(pwszKLID)
// pwszKLID : LPSTR out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetKeyboardLayoutNameA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.GetKeyboardLayoutNameA(pwszKLID)
// pwszKLID : LPSTR out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetKeyboardLayoutNameA(
    char* pwszKLID);
C, "USER32.dll");
// $ffi->GetKeyboardLayoutNameA(pwszKLID);
// pwszKLID : LPSTR 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.ASCII_OPTIONS);
    boolean GetKeyboardLayoutNameA(
        byte[] pwszKLID   // LPSTR out
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetKeyboardLayoutNameA = GetKeyboardLayoutNameA(
    pwszKLID : UInt8*   # LPSTR out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

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