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

GetKeyState

関数
指定した仮想キーの押下・トグル状態を取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

SHORT GetKeyState(
    INT nVirtKey
);

パラメーター

名前方向説明
nVirtKeyINTin

仮想キーです。対象の仮想キーが英字または数字(A から Z、a から z、または 0 から 9)の場合、 nVirtKey にはその文字の ASCII 値を設定する必要があります。それ以外のキーについては、仮想キーコードを指定します。

英語以外のキーボードレイアウトを使用している場合、ASCII の A から Z および 0 から 9 の範囲の値を持つ仮想キーが、ほとんどの文字キーの指定に使用されます。たとえば、ドイツ語キーボードレイアウトでは、ASCII O(0x4F)の仮想キーは「o」キーを指し、VK_OEM_1 は「ウムラウト付き o」キーを指します。

戻り値の型: SHORT

公式ドキュメント

指定された仮想キーの状態を取得します。状態は、キーが離されているか、押されているか、またはトグルされているか(キーを押すたびにオン/オフが交互に切り替わる)を表します。

戻り値

型: SHORT

戻り値は、指定された仮想キーの状態を次のように表します。

解説(Remarks)

この関数が返すキー状態は、スレッドがメッセージキューからキーメッセージを読み取るのに伴って変化します。この状態は、ハードウェアに関連付けられた割り込みレベルの状態を反映するものではありません。その情報を取得するには、GetAsyncKeyState 関数を使用してください。

アプリケーションは、キーボード入力メッセージに応答して GetKeyState を呼び出します。この関数は、入力メッセージが生成された時点でのキーの状態を取得します。

すべての仮想キーの状態情報を取得するには、GetKeyboardState 関数を使用してください。

アプリケーションは、仮想キーコード定数 VK_SHIFTVK_CONTROLVK_MENUnVirtKey パラメーターの値として使用できます。これにより、左右を区別せずに SHIFT、CTRL、または ALT キーの状態を取得できます。アプリケーションは、左右のキーのインスタンスを区別するために、次の仮想キーコード定数を nVirtKey の値として使用することもできます。

VK_LSHIFT VK_RSHIFT VK_LCONTROL VK_RCONTROL VK_LMENU VK_RMENU これらの左右を区別する定数は、GetKeyboardStateSetKeyboardStateGetAsyncKeyStateGetKeyStateMapVirtualKey の各関数を通じてのみアプリケーションで利用できます。

例については、キーボード入力の表示を参照してください。

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

各言語での呼び出し定義

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

SHORT GetKeyState(
    INT nVirtKey
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern short GetKeyState(
    int nVirtKey   // INT
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetKeyState(
    nVirtKey As Integer   ' INT
) As Short
End Function
' nVirtKey : INT
Declare PtrSafe Function GetKeyState Lib "user32" ( _
    ByVal nVirtKey As Long) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetKeyState = ctypes.windll.user32.GetKeyState
GetKeyState.restype = ctypes.c_short
GetKeyState.argtypes = [
    ctypes.c_int,  # nVirtKey : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetKeyState = Fiddle::Function.new(
  lib['GetKeyState'],
  [
    Fiddle::TYPE_INT,  # nVirtKey : INT
  ],
  Fiddle::TYPE_SHORT)
#[link(name = "user32")]
extern "system" {
    fn GetKeyState(
        nVirtKey: i32  // INT
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern short GetKeyState(int nVirtKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetKeyState' -Namespace Win32 -PassThru
# $api::GetKeyState(nVirtKey)
#uselib "USER32.dll"
#func global GetKeyState "GetKeyState" sptr
; GetKeyState nVirtKey   ; 戻り値は stat
; nVirtKey : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetKeyState "GetKeyState" int
; res = GetKeyState(nVirtKey)
; nVirtKey : INT -> "int"
; SHORT GetKeyState(INT nVirtKey)
#uselib "USER32.dll"
#cfunc global GetKeyState "GetKeyState" int
; res = GetKeyState(nVirtKey)
; nVirtKey : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetKeyState = user32.NewProc("GetKeyState")
)

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

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

typedef GetKeyStateNative = Int16 Function(Int32);
typedef GetKeyStateDart = int Function(int);
final GetKeyState = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetKeyStateNative, GetKeyStateDart>('GetKeyState');
// nVirtKey : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetKeyState(
  nVirtKey: Integer   // INT
): Smallint; stdcall;
  external 'USER32.dll' name 'GetKeyState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetKeyState"
  c_GetKeyState :: Int32 -> IO Int16
-- nVirtKey : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("GetKeyState" get-key-state :convention :stdcall) :int16
  (n-virt-key :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetKeyState = Win32::API::More->new('USER32',
    'short GetKeyState(int nVirtKey)');
# my $ret = $GetKeyState->Call($nVirtKey);
# nVirtKey : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目