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

GetKeyboardLayoutList

関数
システム内のキーボードレイアウトハンドルの一覧を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetKeyboardLayoutList(
    INT nBuff,
    HKL* lpList   // optional
);

パラメーター

名前方向説明
nBuffINTinバッファが保持できるハンドルの最大数です。
lpListHKL*outoptional入力ロケール識別子の配列を受け取るバッファへのポインターです。

戻り値の型: INT

公式ドキュメント

システムにおける現在の入力ロケールのセットに対応する入力ロケール識別子(以前はキーボードレイアウトハンドルと呼ばれていました)を取得します。この関数は識別子を指定されたバッファにコピーします。

戻り値

型: int

関数が成功した場合、戻り値はバッファにコピーされた入力ロケール識別子の数です。ただし nBuff が 0 の場合、戻り値は現在のすべての入力ロケール識別子を受け取るために必要なバッファのサイズ(配列要素数)です。

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

解説(Remarks)

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

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

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

各言語での呼び出し定義

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

INT GetKeyboardLayoutList(
    INT nBuff,
    HKL* lpList   // optional
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetKeyboardLayoutList(
    int nBuff,   // INT
    IntPtr lpList   // HKL* optional, out
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetKeyboardLayoutList(
    nBuff As Integer,   ' INT
    lpList As IntPtr   ' HKL* optional, out
) As Integer
End Function
' nBuff : INT
' lpList : HKL* optional, out
Declare PtrSafe Function GetKeyboardLayoutList Lib "user32" ( _
    ByVal nBuff As Long, _
    ByVal lpList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetKeyboardLayoutList = ctypes.windll.user32.GetKeyboardLayoutList
GetKeyboardLayoutList.restype = ctypes.c_int
GetKeyboardLayoutList.argtypes = [
    ctypes.c_int,  # nBuff : INT
    ctypes.c_void_p,  # lpList : HKL* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetKeyboardLayoutList = Fiddle::Function.new(
  lib['GetKeyboardLayoutList'],
  [
    Fiddle::TYPE_INT,  # nBuff : INT
    Fiddle::TYPE_VOIDP,  # lpList : HKL* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetKeyboardLayoutList(
        nBuff: i32,  // INT
        lpList: *mut *mut core::ffi::c_void  // HKL* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern int GetKeyboardLayoutList(int nBuff, IntPtr lpList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetKeyboardLayoutList' -Namespace Win32 -PassThru
# $api::GetKeyboardLayoutList(nBuff, lpList)
#uselib "USER32.dll"
#func global GetKeyboardLayoutList "GetKeyboardLayoutList" sptr, sptr
; GetKeyboardLayoutList nBuff, lpList   ; 戻り値は stat
; nBuff : INT -> "sptr"
; lpList : HKL* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetKeyboardLayoutList "GetKeyboardLayoutList" int, sptr
; res = GetKeyboardLayoutList(nBuff, lpList)
; nBuff : INT -> "int"
; lpList : HKL* optional, out -> "sptr"
; INT GetKeyboardLayoutList(INT nBuff, HKL* lpList)
#uselib "USER32.dll"
#cfunc global GetKeyboardLayoutList "GetKeyboardLayoutList" int, intptr
; res = GetKeyboardLayoutList(nBuff, lpList)
; nBuff : INT -> "int"
; lpList : HKL* optional, out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetKeyboardLayoutList = user32.NewProc("GetKeyboardLayoutList")
)

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

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

typedef GetKeyboardLayoutListNative = Int32 Function(Int32, Pointer<Void>);
typedef GetKeyboardLayoutListDart = int Function(int, Pointer<Void>);
final GetKeyboardLayoutList = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetKeyboardLayoutListNative, GetKeyboardLayoutListDart>('GetKeyboardLayoutList');
// nBuff : INT -> Int32
// lpList : HKL* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetKeyboardLayoutList(
  nBuff: Integer;   // INT
  lpList: Pointer   // HKL* optional, out
): Integer; stdcall;
  external 'USER32.dll' name 'GetKeyboardLayoutList';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetKeyboardLayoutList"
  c_GetKeyboardLayoutList :: Int32 -> Ptr () -> IO Int32
-- nBuff : INT -> Int32
-- lpList : HKL* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getkeyboardlayoutlist =
  foreign "GetKeyboardLayoutList"
    (int32_t @-> (ptr void) @-> returning int32_t)
(* nBuff : INT -> int32_t *)
(* lpList : HKL* optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetKeyboardLayoutList" get-keyboard-layout-list :convention :stdcall) :int32
  (n-buff :int32)   ; INT
  (lp-list :pointer))   ; HKL* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetKeyboardLayoutList = Win32::API::More->new('USER32',
    'int GetKeyboardLayoutList(int nBuff, HANDLE lpList)');
# my $ret = $GetKeyboardLayoutList->Call($nBuff, $lpList);
# nBuff : INT -> int
# lpList : HKL* optional, out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目