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

keybd_event

関数
キーボードのキー押下・解放イベントを合成する(旧式)。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void keybd_event(
    BYTE bVk,
    BYTE bScan,
    KEYBD_EVENT_FLAGS dwFlags,
    UINT_PTR dwExtraInfo
);

パラメーター

名前方向説明
bVkBYTEin仮想キーコード。値は 1 から 254 の範囲でなければなりません。完全な一覧については、Virtual Key Codes を参照してください。
bScanBYTEinキーのハードウェアスキャンコード。
dwFlagsKEYBD_EVENT_FLAGSin

関数動作のさまざまな側面を制御します。このパラメーターには、次の値の 1 つ以上を指定できます。

意味
KEYEVENTF_EXTENDEDKEY
0x0001
指定した場合、スキャンコードの前に値 0xE0 (224) のプレフィックスバイトが付加されていたことを示します。
KEYEVENTF_KEYUP
0x0002
指定した場合、キーが離されることを示します。指定しない場合、キーが押されることを示します。
dwExtraInfoUINT_PTRinキーストロークに関連付けられる追加の値。

戻り値の型: void

公式ドキュメント

キーストロークを合成します。

解説(Remarks)

アプリケーションは、画面のスナップショットを取得してクリップボードに保存するために、PRINTSCRN キーの押下をシミュレートできます。これを行うには、bVk パラメーターに VK_SNAPSHOT を設定して

            <b>keybd_event</b> を呼び出します。 

次のサンプルプログラムは、仮想キー VK_NUMLOCK を指定して keybd_event を使用し、NUM LOCK のランプを切り替えます。ランプをオフ (FALSE) にするかオン (TRUE) にするかを示すブール値を受け取ります。同じ手法は、CAPS LOCK キー (VK_CAPITAL) や SCROLL LOCK キー (VK_SCROLL) にも使用できます。


   #include <windows.h>

   void SetNumLock( BOOL bState )
   {
      BYTE keyState[256];

      GetKeyboardState((LPBYTE)&keyState);
      if( (bState && !(keyState[VK_NUMLOCK] & 1)) ||
          (!bState && (keyState[VK_NUMLOCK] & 1)) )
      {
      // Simulate a key press
         keybd_event( VK_NUMLOCK,
                      0x45,
                      KEYEVENTF_EXTENDEDKEY | 0,
                      0 );

      // Simulate a key release
         keybd_event( VK_NUMLOCK,
                      0x45,
                      KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP,
                      0);
      }
   }

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

各言語での呼び出し定義

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

void keybd_event(
    BYTE bVk,
    BYTE bScan,
    KEYBD_EVENT_FLAGS dwFlags,
    UINT_PTR dwExtraInfo
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern void keybd_event(
    byte bVk,   // BYTE
    byte bScan,   // BYTE
    uint dwFlags,   // KEYBD_EVENT_FLAGS
    UIntPtr dwExtraInfo   // UINT_PTR
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Sub keybd_event(
    bVk As Byte,   ' BYTE
    bScan As Byte,   ' BYTE
    dwFlags As UInteger,   ' KEYBD_EVENT_FLAGS
    dwExtraInfo As UIntPtr   ' UINT_PTR
)
End Sub
' bVk : BYTE
' bScan : BYTE
' dwFlags : KEYBD_EVENT_FLAGS
' dwExtraInfo : UINT_PTR
Declare PtrSafe Sub keybd_event Lib "user32" ( _
    ByVal bVk As Byte, _
    ByVal bScan As Byte, _
    ByVal dwFlags As Long, _
    ByVal dwExtraInfo As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

keybd_event = ctypes.windll.user32.keybd_event
keybd_event.restype = None
keybd_event.argtypes = [
    ctypes.c_ubyte,  # bVk : BYTE
    ctypes.c_ubyte,  # bScan : BYTE
    wintypes.DWORD,  # dwFlags : KEYBD_EVENT_FLAGS
    ctypes.c_size_t,  # dwExtraInfo : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
keybd_event = Fiddle::Function.new(
  lib['keybd_event'],
  [
    -Fiddle::TYPE_CHAR,  # bVk : BYTE
    -Fiddle::TYPE_CHAR,  # bScan : BYTE
    -Fiddle::TYPE_INT,  # dwFlags : KEYBD_EVENT_FLAGS
    Fiddle::TYPE_UINTPTR_T,  # dwExtraInfo : UINT_PTR
  ],
  Fiddle::TYPE_VOID)
#[link(name = "user32")]
extern "system" {
    fn keybd_event(
        bVk: u8,  // BYTE
        bScan: u8,  // BYTE
        dwFlags: u32,  // KEYBD_EVENT_FLAGS
        dwExtraInfo: usize  // UINT_PTR
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern void keybd_event(byte bVk, byte bScan, uint dwFlags, UIntPtr dwExtraInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_keybd_event' -Namespace Win32 -PassThru
# $api::keybd_event(bVk, bScan, dwFlags, dwExtraInfo)
#uselib "USER32.dll"
#func global keybd_event "keybd_event" sptr, sptr, sptr, sptr
; keybd_event bVk, bScan, dwFlags, dwExtraInfo
; bVk : BYTE -> "sptr"
; bScan : BYTE -> "sptr"
; dwFlags : KEYBD_EVENT_FLAGS -> "sptr"
; dwExtraInfo : UINT_PTR -> "sptr"
#uselib "USER32.dll"
#func global keybd_event "keybd_event" int, int, int, sptr
; keybd_event bVk, bScan, dwFlags, dwExtraInfo
; bVk : BYTE -> "int"
; bScan : BYTE -> "int"
; dwFlags : KEYBD_EVENT_FLAGS -> "int"
; dwExtraInfo : UINT_PTR -> "sptr"
; void keybd_event(BYTE bVk, BYTE bScan, KEYBD_EVENT_FLAGS dwFlags, UINT_PTR dwExtraInfo)
#uselib "USER32.dll"
#func global keybd_event "keybd_event" int, int, int, intptr
; keybd_event bVk, bScan, dwFlags, dwExtraInfo
; bVk : BYTE -> "int"
; bScan : BYTE -> "int"
; dwFlags : KEYBD_EVENT_FLAGS -> "int"
; dwExtraInfo : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	prockeybd_event = user32.NewProc("keybd_event")
)

// bVk (BYTE), bScan (BYTE), dwFlags (KEYBD_EVENT_FLAGS), dwExtraInfo (UINT_PTR)
r1, _, err := prockeybd_event.Call(
	uintptr(bVk),
	uintptr(bScan),
	uintptr(dwFlags),
	uintptr(dwExtraInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure keybd_event(
  bVk: Byte;   // BYTE
  bScan: Byte;   // BYTE
  dwFlags: DWORD;   // KEYBD_EVENT_FLAGS
  dwExtraInfo: NativeUInt   // UINT_PTR
); stdcall;
  external 'USER32.dll' name 'keybd_event';
result := DllCall("USER32\keybd_event"
    , "UChar", bVk   ; BYTE
    , "UChar", bScan   ; BYTE
    , "UInt", dwFlags   ; KEYBD_EVENT_FLAGS
    , "UPtr", dwExtraInfo   ; UINT_PTR
    , "Int")   ; return: void
●keybd_event(bVk, bScan, dwFlags, dwExtraInfo) = DLL("USER32.dll", "int keybd_event(byte, byte, dword, int)")
# 呼び出し: keybd_event(bVk, bScan, dwFlags, dwExtraInfo)
# bVk : BYTE -> "byte"
# bScan : BYTE -> "byte"
# dwFlags : KEYBD_EVENT_FLAGS -> "dword"
# dwExtraInfo : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef keybd_eventNative = Void Function(Uint8, Uint8, Uint32, UintPtr);
typedef keybd_eventDart = void Function(int, int, int, int);
final keybd_event = DynamicLibrary.open('USER32.dll')
    .lookupFunction<keybd_eventNative, keybd_eventDart>('keybd_event');
// bVk : BYTE -> Uint8
// bScan : BYTE -> Uint8
// dwFlags : KEYBD_EVENT_FLAGS -> Uint32
// dwExtraInfo : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure keybd_event(
  bVk: Byte;   // BYTE
  bScan: Byte;   // BYTE
  dwFlags: DWORD;   // KEYBD_EVENT_FLAGS
  dwExtraInfo: NativeUInt   // UINT_PTR
); stdcall;
  external 'USER32.dll' name 'keybd_event';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "keybd_event"
  c_keybd_event :: Word8 -> Word8 -> Word32 -> CUIntPtr -> IO ()
-- bVk : BYTE -> Word8
-- bScan : BYTE -> Word8
-- dwFlags : KEYBD_EVENT_FLAGS -> Word32
-- dwExtraInfo : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let keybd_event =
  foreign "keybd_event"
    (uint8_t @-> uint8_t @-> uint32_t @-> size_t @-> returning void)
(* bVk : BYTE -> uint8_t *)
(* bScan : BYTE -> uint8_t *)
(* dwFlags : KEYBD_EVENT_FLAGS -> uint32_t *)
(* dwExtraInfo : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("keybd_event" keybd-event :convention :stdcall) :void
  (b-vk :uint8)   ; BYTE
  (b-scan :uint8)   ; BYTE
  (dw-flags :uint32)   ; KEYBD_EVENT_FLAGS
  (dw-extra-info :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $keybd_event = Win32::API::More->new('USER32',
    'void keybd_event(BYTE bVk, BYTE bScan, DWORD dwFlags, WPARAM dwExtraInfo)');
# my $ret = $keybd_event->Call($bVk, $bScan, $dwFlags, $dwExtraInfo);
# bVk : BYTE -> BYTE
# bScan : BYTE -> BYTE
# dwFlags : KEYBD_EVENT_FLAGS -> DWORD
# dwExtraInfo : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型