ホーム › UI.Input.KeyboardAndMouse › GetKeyboardState

GetKeyboardState

関数

全仮想キーの状態を配列としてまとめて取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetKeyboardState(
    BYTE* lpKeyState
);

パラメーター

名前	型	方向	説明
lpKeyState	BYTE*	out	各仮想キーの状態データを受け取る 256 バイトの配列です。

戻り値の型: BOOL

公式ドキュメント

256 個の仮想キーの状態を、指定したバッファーにコピーします。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外になります。

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

解説(Remarks)

アプリケーションは、この関数を呼び出してすべての仮想キーの現在の状態を取得できます。状態は、スレッドがメッセージキューからキーボードメッセージを取り除くにつれて変化します。状態は、キーボードメッセージがスレッドのメッセージキューにポストされても変化せず、また他のスレッドのメッセージキューにキーボードメッセージがポストされたり、そこから取得されたりしても変化しません。(例外: AttachThreadInput を通じて接続されたスレッドは、同じキーボード状態を共有します。)

関数が戻ると、 lpKeyState パラメーターが指す配列の各メンバーには、仮想キーの状態データが格納されます。最上位ビットが 1 の場合、そのキーは押されています。それ以外の場合は離されています。CAPS LOCK のようなトグルキーの場合、最下位ビットはキーがトグルされているときに 1 になり、トグルされていないときに 0 になります。非トグルキーでは最下位ビットに意味はありません。トグルキーは、オンになっているときにトグルされているといいます。キーボード上のトグルキーのインジケーターランプ(存在する場合)は、キーがトグルされているときに点灯し、トグルされていないときに消灯します。

個々のキーの状態情報を取得するには、GetKeyState 関数を使用します。対応するキーボードメッセージがメッセージキューから取得されているかどうかにかかわらず、個々のキーの現在の状態を取得するには、GetAsyncKeyState 関数を使用します。

アプリケーションは、仮想キーコード定数 VK_SHIFT、VK_CONTROL、VK_MENU を、 lpKeyState が指す配列のインデックスとして使用できます。これにより、左右を区別せずに SHIFT、CTRL、ALT キーの状態が得られます。また、アプリケーションは次の仮想キーコード定数をインデックスとして使用し、それらのキーの左右のインスタンスを区別することもできます。

VK_LSHIFT

VK_RSHIFT

VK_LCONTROL

VK_RCONTROL

VK_LMENU

VK_RMENU

これらの左右を区別する定数は、GetKeyboardState、SetKeyboardState、GetAsyncKeyState、GetKeyState、MapVirtualKey の各関数を通じてのみアプリケーションで利用できます。

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

各言語での呼び出し定義

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

BOOL GetKeyboardState(
    BYTE* lpKeyState
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetKeyboardState(
    IntPtr lpKeyState   // BYTE* out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetKeyboardState(
    lpKeyState As IntPtr   ' BYTE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpKeyState : BYTE* out
Declare PtrSafe Function GetKeyboardState Lib "user32" ( _
    ByVal lpKeyState As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetKeyboardState = ctypes.windll.user32.GetKeyboardState
GetKeyboardState.restype = wintypes.BOOL
GetKeyboardState.argtypes = [
    ctypes.POINTER(ctypes.c_ubyte),  # lpKeyState : BYTE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetKeyboardState = Fiddle::Function.new(
  lib['GetKeyboardState'],
  [
    Fiddle::TYPE_VOIDP,  # lpKeyState : BYTE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetKeyboardState(
        lpKeyState: *mut u8  // BYTE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetKeyboardState(IntPtr lpKeyState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetKeyboardState' -Namespace Win32 -PassThru
# $api::GetKeyboardState(lpKeyState)

#uselib "USER32.dll"
#func global GetKeyboardState "GetKeyboardState" sptr
; GetKeyboardState varptr(lpKeyState)   ; 戻り値は stat
; lpKeyState : BYTE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetKeyboardState "GetKeyboardState" var
; res = GetKeyboardState(lpKeyState)
; lpKeyState : BYTE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetKeyboardState "GetKeyboardState" sptr
; res = GetKeyboardState(varptr(lpKeyState))
; lpKeyState : BYTE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。