ホーム › UI.Input.KeyboardAndMouse › SendInput

SendInput

関数

キーボード・マウスなどの入力イベントを合成して送る。

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

シグネチャ

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

DWORD SendInput(
    DWORD cInputs,
    INPUT* pInputs,
    INT cbSize
);

パラメーター

名前	型	方向	説明
cInputs	DWORD	in	pInputs 配列内の構造体の数です。
pInputs	INPUT*	in	INPUT 構造体の配列です。各構造体は、キーボードまたはマウスの入力ストリームに挿入されるイベントを表します。
cbSize	INT	in	INPUT 構造体のサイズ(バイト単位)です。cbSize が INPUT 構造体のサイズと異なる場合、関数は失敗します。

戻り値の型: DWORD

公式ドキュメント

キーストローク、マウスの動き、ボタンのクリックを合成します。

戻り値

型: UINT

この関数は、キーボードまたはマウスの入力ストリームに正常に挿入したイベントの数を返します。関数が 0 を返した場合、入力はすでに別のスレッドによってブロックされていました。拡張エラー情報を取得するには、GetLastError を呼び出してください。

この関数は UIPI によってブロックされると失敗します。GetLastError および戻り値のいずれも、失敗の原因が UIPI によるブロックであることを示さない点に注意してください。

解説(Remarks)

この関数は UIPI の対象です。アプリケーションは、同等以下の整合性レベルにあるアプリケーションに対してのみ入力を挿入することが許可されます。

SendInput 関数は、INPUT 構造体内のイベントを、キーボードまたはマウスの入力ストリームに順次挿入します。これらのイベントは、ユーザー(キーボードまたはマウスによる操作)や、keybd_event、mouse_event、または他の SendInput 呼び出しによって挿入される他のキーボードまたはマウスの入力イベントと混在することはありません。

この関数はキーボードの現在の状態をリセットしません。関数が呼び出された時点ですでに押されているキーは、この関数が生成するイベントに干渉する可能性があります。この問題を回避するには、GetAsyncKeyState 関数でキーボードの状態を確認し、必要に応じて修正してください。

タッチキーボードは、winnls.h で定義されたサロゲートマクロを使用してシステムに入力を送信するため、キーボードイベントフックのリスナーは、タッチキーボードを起点とする入力をデコードする必要があります。詳細については、Surrogates and Supplementary Characters を参照してください。

アクセシビリティアプリケーションは、SendInput を使用して、シェルによって処理されるアプリケーション起動ショートカットキーに対応するキーストロークを挿入できます。この機能は、他の種類のアプリケーションで動作する保証はありません。

例

//**********************************************************************
//
// Sends Win + D to toggle to the desktop
//
//**********************************************************************
void ShowDesktop()
{
    OutputString(L"Sending 'Win-D'\r\n");
    INPUT inputs[4] = {};
    ZeroMemory(inputs, sizeof(inputs));

    inputs[0].type = INPUT_KEYBOARD;
    inputs[0].ki.wVk = VK_LWIN;
   
    inputs[1].type = INPUT_KEYBOARD;
    inputs[1].ki.wVk = 'D';

    inputs[2].type = INPUT_KEYBOARD;
    inputs[2].ki.wVk = 'D';
    inputs[2].ki.dwFlags = KEYEVENTF_KEYUP;

    inputs[3].type = INPUT_KEYBOARD;
    inputs[3].ki.wVk = VK_LWIN;
    inputs[3].ki.dwFlags = KEYEVENTF_KEYUP;

    UINT uSent = SendInput(ARRAYSIZE(inputs), inputs, sizeof(INPUT));
    if (uSent != ARRAYSIZE(inputs))
    {
        OutputString(L"SendInput failed: 0x%x\n", HRESULT_FROM_WIN32(GetLastError()));
    } 
}

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

各言語での呼び出し定義

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

DWORD SendInput(
    DWORD cInputs,
    INPUT* pInputs,
    INT cbSize
);

[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint SendInput(
    uint cInputs,   // DWORD
    IntPtr pInputs,   // INPUT*
    int cbSize   // INT
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SendInput(
    cInputs As UInteger,   ' DWORD
    pInputs As IntPtr,   ' INPUT*
    cbSize As Integer   ' INT
) As UInteger
End Function

' cInputs : DWORD
' pInputs : INPUT*
' cbSize : INT
Declare PtrSafe Function SendInput Lib "user32" ( _
    ByVal cInputs As Long, _
    ByVal pInputs As LongPtr, _
    ByVal cbSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SendInput = ctypes.windll.user32.SendInput
SendInput.restype = wintypes.DWORD
SendInput.argtypes = [
    wintypes.DWORD,  # cInputs : DWORD
    ctypes.c_void_p,  # pInputs : INPUT*
    ctypes.c_int,  # cbSize : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SendInput = Fiddle::Function.new(
  lib['SendInput'],
  [
    -Fiddle::TYPE_INT,  # cInputs : DWORD
    Fiddle::TYPE_VOIDP,  # pInputs : INPUT*
    Fiddle::TYPE_INT,  # cbSize : INT
  ],
  -Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn SendInput(
        cInputs: u32,  // DWORD
        pInputs: *mut INPUT,  // INPUT*
        cbSize: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern uint SendInput(uint cInputs, IntPtr pInputs, int cbSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SendInput' -Namespace Win32 -PassThru
# $api::SendInput(cInputs, pInputs, cbSize)

#uselib "USER32.dll"
#func global SendInput "SendInput" sptr, sptr, sptr
; SendInput cInputs, varptr(pInputs), cbSize   ; 戻り値は stat
; cInputs : DWORD -> "sptr"
; pInputs : INPUT* -> "sptr"
; cbSize : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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