Win32 API 日本語リファレンス
ホーム › System.Console › GetConsoleKeyboardLayoutNameA

GetConsoleKeyboardLayoutNameA

関数
現在のコンソールのキーボードレイアウト名を取得する(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

BOOL GetConsoleKeyboardLayoutNameA(
    LPSTR pszLayout
);

パラメーター

名前型方向説明
pszLayoutLPSTRout現在のコンソール入力のキーボードレイアウト名を受け取るANSIバッファへのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GetConsoleKeyboardLayoutNameA = ctypes.windll.user32.GetConsoleKeyboardLayoutNameA
GetConsoleKeyboardLayoutNameA.restype = wintypes.BOOL
GetConsoleKeyboardLayoutNameA.argtypes = [
    wintypes.LPSTR,  # pszLayout : LPSTR out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetConsoleKeyboardLayoutNameA = Fiddle::Function.new(
  lib['GetConsoleKeyboardLayoutNameA'],
  [
    Fiddle::TYPE_VOIDP,  # pszLayout : LPSTR out
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetConsoleKeyboardLayoutNameA(
        pszLayout: *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)]
public static extern bool GetConsoleKeyboardLayoutNameA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszLayout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetConsoleKeyboardLayoutNameA' -Namespace Win32 -PassThru
# $api::GetConsoleKeyboardLayoutNameA(pszLayout)
#uselib "USER32.dll"
#func global GetConsoleKeyboardLayoutNameA "GetConsoleKeyboardLayoutNameA" sptr
; GetConsoleKeyboardLayoutNameA varptr(pszLayout)   ; 戻り値は stat
; pszLayout : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "USER32.dll"
#cfunc global GetConsoleKeyboardLayoutNameA "GetConsoleKeyboardLayoutNameA" var
; res = GetConsoleKeyboardLayoutNameA(pszLayout)
; pszLayout : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL GetConsoleKeyboardLayoutNameA(LPSTR pszLayout)
#uselib "USER32.dll"
#cfunc global GetConsoleKeyboardLayoutNameA "GetConsoleKeyboardLayoutNameA" var
; res = GetConsoleKeyboardLayoutNameA(pszLayout)
; pszLayout : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetConsoleKeyboardLayoutNameA = user32.NewProc("GetConsoleKeyboardLayoutNameA")
)

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

extern "user32" fn GetConsoleKeyboardLayoutNameA(
    pszLayout: [*c]u8 // LPSTR out
) callconv(std.os.windows.WINAPI) i32;
proc GetConsoleKeyboardLayoutNameA(
    pszLayout: ptr char  # LPSTR out
): int32 {.importc: "GetConsoleKeyboardLayoutNameA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int GetConsoleKeyboardLayoutNameA(
    char* pszLayout   // LPSTR out
);
ccall((:GetConsoleKeyboardLayoutNameA, "USER32.dll"), stdcall, Int32,
      (Ptr{UInt8},),
      pszLayout)
# pszLayout : LPSTR out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetConsoleKeyboardLayoutNameA(
    char* pszLayout);
]]
local user32 = ffi.load("user32")
-- user32.GetConsoleKeyboardLayoutNameA(pszLayout)
-- pszLayout : LPSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetConsoleKeyboardLayoutNameA = lib.func('__stdcall', 'GetConsoleKeyboardLayoutNameA', 'int32_t', ['char *']);
// GetConsoleKeyboardLayoutNameA(pszLayout)
// pszLayout : LPSTR out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetConsoleKeyboardLayoutNameA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.GetConsoleKeyboardLayoutNameA(pszLayout)
// pszLayout : LPSTR out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetConsoleKeyboardLayoutNameA(
    char* pszLayout);
C, "USER32.dll");
// $ffi->GetConsoleKeyboardLayoutNameA(pszLayout);
// pszLayout : 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 GetConsoleKeyboardLayoutNameA(
        byte[] pszLayout   // LPSTR out
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetConsoleKeyboardLayoutNameA = GetConsoleKeyboardLayoutNameA(
    pszLayout : 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 GetConsoleKeyboardLayoutNameANative = Int32 Function(Pointer<Utf8>);
typedef GetConsoleKeyboardLayoutNameADart = int Function(Pointer<Utf8>);
final GetConsoleKeyboardLayoutNameA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetConsoleKeyboardLayoutNameANative, GetConsoleKeyboardLayoutNameADart>('GetConsoleKeyboardLayoutNameA');
// pszLayout : LPSTR out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetConsoleKeyboardLayoutNameA(
  pszLayout: PAnsiChar   // LPSTR out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetConsoleKeyboardLayoutNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getconsolekeyboardlayoutnamea =
  foreign "GetConsoleKeyboardLayoutNameA"
    (string @-> returning int32_t)
(* pszLayout : 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 ("GetConsoleKeyboardLayoutNameA" get-console-keyboard-layout-name-a :convention :stdcall) :int32
  (psz-layout :pointer))   ; LPSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleKeyboardLayoutNameA = Win32::API::More->new('USER32',
    'BOOL GetConsoleKeyboardLayoutNameA(LPSTR pszLayout)');
# my $ret = $GetConsoleKeyboardLayoutNameA->Call($pszLayout);
# pszLayout : LPSTR out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い