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

GetAsyncKeyState

関数
呼び出し時点のキーの押下状態を非同期に取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

SHORT GetAsyncKeyState(
    INT vKey
);

パラメーター

名前方向説明
vKeyINTin

仮想キーコードです。詳細については、Virtual Key Codes を参照してください。

特定のキーを指定するために、左右を区別する定数を使用できます。詳細については「解説」セクションを参照してください。

戻り値の型: SHORT

公式ドキュメント

関数が呼び出された時点でキーが押されているか離されているか、およびそのキーが前回の GetAsyncKeyState 呼び出し以降に押されたかどうかを判定します。

戻り値

型: SHORT

指定したキーが現在押されている場合、戻り値の最上位ビットが設定されます。 最上位ビットは符号ビットであるため、負の値はそのキーが現在押されていることを示します。

下位互換性のため、指定したキーがそのキーに対するセッション内の直前の GetAsyncKeyState 呼び出し以降に押されていた場合は最下位ビットが設定されますが、この値は信頼できません。(「解説」を参照してください。)

結果のその他のすべてのビットは予約されており、無視してください。

呼び出しが失敗した場合、戻り値は 0 になります。 失敗する原因には次のものがあります。

解説(Remarks)

GetAsyncKeyState 関数はマウスボタンにも対応しています。ただし、物理マウスボタンがマッピングされている論理マウスボタンではなく、物理マウスボタンの状態を調べます。たとえば、GetAsyncKeyState(VK_LBUTTON) の呼び出しは、左または右のどちらの論理マウスボタンにマッピングされているかにかかわらず、常に左の物理マウスボタンの状態を返します。物理マウスボタンと論理マウスボタンの現在のマッピングは、GetSystemMetrics(SM_SWAPBUTTON) を呼び出すことで判定できます。これはマウスボタンが入れ替えられている場合に TRUE を返します。

戻り値の最下位ビットは前回の問い合わせ以降にキーが押されたかどうかを示しますが、Windows のプリエンプティブなマルチタスクの性質上、別のアプリケーションが GetAsyncKeyState を呼び出し、ご自身のアプリケーションの代わりに「最近押された」ビットを受け取ってしまう場合があります。最下位ビットの動作は 16 ビット Windows アプリケーション(非プリエンプティブ)との互換性のために残されているものであり、誤った否定的結果(false negative)を報告する可能性があるため、これに依存しないでください。

仮想キーコード定数 VK_SHIFTVK_CONTROLVK_MENUvKey パラメーターの値として使用できます。これにより、左右を区別せずに SHIFT、CTRL、ALT キーの状態を取得できます。

左右のキーを区別するには、次の仮想キーコード定数を vKey の値として使用できます。

Code Meaning
VK_LSHIFT 左 SHIFT キー。
VK_RSHIFT 右 SHIFT キー。
VK_LCONTROL 左 CONTROL キー。
VK_RCONTROL 右 CONTROL キー。
VK_LMENU 左 MENU キー。
VK_RMENU 右 MENU キー。

これら左右を区別する定数は、GetKeyboardStateSetKeyboardStateGetAsyncKeyStateGetKeyStateMapVirtualKey の各関数を呼び出す場合にのみ使用できます。

int APIENTRY WinMain(HINSTANCE hInst, HINSTANCE hInstPrev, PSTR cmdline, int cmdshow)
{
    BOOL considerSafeMode = FALSE;

    // If the user holds the CTRL key while the app is launching,
    // then offer to enter Safe Mode.
    if (GetAsyncKeyState(VK_CONTROL) < 0)
    {
        considerSafeMode = TRUE;
    }

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

各言語での呼び出し定義

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

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

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

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetAsyncKeyState = user32.NewProc("GetAsyncKeyState")
)

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

extern "user32" fn GetAsyncKeyState(
    vKey: i32 // INT
) callconv(std.os.windows.WINAPI) i16;
proc GetAsyncKeyState(
    vKey: int32  # INT
): int16 {.importc: "GetAsyncKeyState", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
short GetAsyncKeyState(
    int vKey   // INT
);
ccall((:GetAsyncKeyState, "USER32.dll"), stdcall, Int16,
      (Int32,),
      vKey)
# vKey : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int16_t GetAsyncKeyState(
    int32_t vKey);
]]
local user32 = ffi.load("user32")
-- user32.GetAsyncKeyState(vKey)
-- vKey : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetAsyncKeyState = lib.func('__stdcall', 'GetAsyncKeyState', 'int16_t', ['int32_t']);
// GetAsyncKeyState(vKey)
// vKey : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetAsyncKeyState: { parameters: ["i32"], result: "i16" },
});
// lib.symbols.GetAsyncKeyState(vKey)
// vKey : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int16_t GetAsyncKeyState(
    int32_t vKey);
C, "USER32.dll");
// $ffi->GetAsyncKeyState(vKey);
// vKey : 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 GetAsyncKeyState(
        int vKey   // INT
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetAsyncKeyState = GetAsyncKeyState(
    vKey : 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 GetAsyncKeyStateNative = Int16 Function(Int32);
typedef GetAsyncKeyStateDart = int Function(int);
final GetAsyncKeyState = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetAsyncKeyStateNative, GetAsyncKeyStateDart>('GetAsyncKeyState');
// vKey : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetAsyncKeyState(
  vKey: Integer   // INT
): Smallint; stdcall;
  external 'USER32.dll' name 'GetAsyncKeyState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getasynckeystate =
  foreign "GetAsyncKeyState"
    (int32_t @-> returning int16_t)
(* vKey : 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 ("GetAsyncKeyState" get-async-key-state :convention :stdcall) :int16
  (v-key :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetAsyncKeyState = Win32::API::More->new('USER32',
    'short GetAsyncKeyState(int vKey)');
# my $ret = $GetAsyncKeyState->Call($vKey);
# vKey : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目