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

mouse_event

関数
マウスの移動やボタンイベントを合成する(旧式)。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void mouse_event(
    MOUSE_EVENT_FLAGS dwFlags,
    INT dx,
    INT dy,
    INT dwData,
    UINT_PTR dwExtraInfo
);

パラメーター

名前方向説明
dwFlagsMOUSE_EVENT_FLAGSin

マウスの移動やボタンのクリックに関するさまざまな動作を制御します。このパラメーターには、次の値の特定の組み合わせを指定できます。

意味
MOUSEEVENTF_ABSOLUTE
0x8000
dx および dy パラメーターに、正規化された絶対座標が含まれます。設定されていない場合、これらのパラメーターには相対データ(前回報告された位置からの位置の変化)が含まれます。このフラグは、システムに接続されているマウスやマウス類似デバイスの種類にかかわらず(また接続されていなくても)、設定することも設定しないこともできます。相対的なマウス移動の詳細については、後述の「解説」セクションを参照してください。
MOUSEEVENTF_LEFTDOWN
0x0002
左ボタンが押された状態です。
MOUSEEVENTF_LEFTUP
0x0004
左ボタンが離された状態です。
MOUSEEVENTF_MIDDLEDOWN
0x0020
中央ボタンが押された状態です。
MOUSEEVENTF_MIDDLEUP
0x0040
中央ボタンが離された状態です。
MOUSEEVENTF_MOVE
0x0001
移動が発生しました。
MOUSEEVENTF_RIGHTDOWN
0x0008
右ボタンが押された状態です。
MOUSEEVENTF_RIGHTUP
0x0010
右ボタンが離された状態です。
MOUSEEVENTF_WHEEL
0x0800
マウスにホイールがある場合、ホイールが移動しました。移動量は dwData で指定されます。
MOUSEEVENTF_XDOWN
0x0080
X ボタンが押されました。
MOUSEEVENTF_XUP
0x0100
X ボタンが離されました。
MOUSEEVENTF_WHEEL
0x0800
ホイールボタンが回転しました。
MOUSEEVENTF_HWHEEL
0x01000
ホイールボタンが傾けられました。

マウスボタンの状態を指定する値は、継続中の状態ではなく、状態の変化を示すために設定されます。たとえば、左マウスボタンを押したまま保持する場合、MOUSEEVENTF_LEFTDOWN は左ボタンが最初に押されたときに設定されますが、その後の移動では設定されません。同様に、MOUSEEVENTF_LEFTUP はボタンが最初に離されたときにのみ設定されます。

MOUSEEVENTF_WHEEL と、MOUSEEVENTF_XDOWN または MOUSEEVENTF_XUP のいずれかを、dwFlags パラメーターに同時に指定することはできません。これらはいずれも dwData フィールドを使用するためです。

dxINTinMOUSEEVENTF_ABSOLUTE の設定に応じて、マウスの x 軸方向の絶対位置、または前回マウスイベントが生成されてからの移動量を指定します。絶対データはマウスの実際の x 座標として指定され、相対データは移動したミッキー(mickey)の数として指定されます。mickey とは、マウスが移動したことを報告するために必要な移動量のことです。
dyINTinMOUSEEVENTF_ABSOLUTE の設定に応じて、マウスの y 軸方向の絶対位置、または前回マウスイベントが生成されてからの移動量を指定します。絶対データはマウスの実際の y 座標として指定され、相対データは移動したミッキーの数として指定されます。
dwDataINTin

dwFlagsMOUSEEVENTF_WHEEL が含まれる場合、dwData はホイールの移動量を指定します。正の値はホイールがユーザーから離れる方向(前方)に回転したことを、負の値はユーザーに向かう方向(後方)に回転したことを示します。ホイール1クリックは WHEEL_DELTA(値は 120)として定義されています。

dwFlagsMOUSEEVENTF_HWHEEL が含まれる場合、dwData はホイールの移動量を指定します。正の値はホイールが右に傾けられたことを、負の値は左に傾けられたことを示します。

dwFlagsMOUSEEVENTF_XDOWN または MOUSEEVENTF_XUP が含まれる場合、dwData は押された、または離された X ボタンを指定します。この値には、次のフラグの任意の組み合わせを指定できます。

dwFlagsMOUSEEVENTF_WHEELMOUSEEVENTF_XDOWNMOUSEEVENTF_XUP のいずれでもない場合、dwData はゼロにする必要があります。

意味
XBUTTON1
0x0001
1 つ目の X ボタンが押された、または離された場合に設定されます。
XBUTTON2
0x0002
2 つ目の X ボタンが押された、または離された場合に設定されます。
dwExtraInfoUINT_PTRinマウスイベントに関連付けられた追加の値です。アプリケーションは、この追加情報を取得するために GetMessageExtraInfo を呼び出します。

戻り値の型: void

公式ドキュメント

mouse_event 関数は、マウスの移動とボタンのクリックを合成します。

解説(Remarks)

MOUSEEVENTF_MOVE が設定されてマウスが移動したことが示されている場合、dxdy にはその移動に関する情報が保持されます。この情報は絶対値または相対値の整数として指定されます。

MOUSEEVENTF_ABSOLUTE 値が指定されている場合、dxdy には 0 から 65,535 の間で正規化された絶対座標が含まれます。イベントプロシージャはこれらの座標を表示面上にマッピングします。座標 (0,0) は表示面の左上隅に、(65535,65535) は右下隅にマッピングされます。

MOUSEEVENTF_ABSOLUTE 値が指定されていない場合、dxdy は、前回マウスイベントが生成された時点(前回報告された位置)からの相対的な移動を指定します。正の値はマウスが右(または下)に移動したことを、負の値はマウスが左(または上)に移動したことを意味します。

相対的なマウス移動は、マウスの速度と加速レベルの設定の影響を受けます。エンドユーザーは、コントロールパネルの「マウス」アプリケーションを使用してこれらの値を設定します。アプリケーションは、SystemParametersInfo 関数を使用してこれらの値を取得および設定します。

システムは、加速を適用する際に、指定された相対的なマウス移動に対して 2 つのテストを行います。x 軸または y 軸のいずれかに沿って指定された距離が 1 つ目のマウスしきい値を超えており、かつマウスの加速レベルがゼロでない場合、オペレーティングシステムはその距離を 2 倍にします。x 軸または y 軸のいずれかに沿って指定された距離が 2 つ目のマウスしきい値を超えており、かつマウスの加速レベルが 2 に等しい場合、オペレーティングシステムは 1 つ目のしきい値テストを適用した結果の距離をさらに 2 倍にします。したがって、オペレーティングシステムは、x 軸または y 軸に沿って相対指定されたマウス移動を最大 4 倍にすることがあります。

加速が適用された後、システムは結果の値を指定されたマウス速度に応じてスケーリングします。マウス速度は 1(最も遅い)から 20(最も速い)までの範囲で、マウスの移動距離に対してポインターがどれだけ移動するかを表します。既定値は 10 で、この場合マウス移動に対する追加の変更は行われません。

mouse_event 関数は、マウスイベントの合成を必要とするアプリケーションによって、それを行うために使用されます。また、マウスから位置やボタンの状態以上の情報を取得する必要があるアプリケーションでも使用されます。たとえば、タブレットの製造元がペンベースの情報を独自のアプリケーションに渡したい場合、タブレットのハードウェアと直接通信し、追加情報を取得してキューに保存する DLL を作成できます。その DLL は、標準のボタンおよび x/y 位置データとともに、dwExtraInfo パラメーターにキューに格納された追加情報へのポインターまたはインデックスを指定して、mouse_event を呼び出します。アプリケーションが追加情報を必要とするとき、dwExtraInfo に格納されたポインターまたはインデックスを指定して DLL を呼び出すと、DLL は追加情報を返します。

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

各言語での呼び出し定義

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

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

mouse_event = ctypes.windll.user32.mouse_event
mouse_event.restype = None
mouse_event.argtypes = [
    wintypes.DWORD,  # dwFlags : MOUSE_EVENT_FLAGS
    ctypes.c_int,  # dx : INT
    ctypes.c_int,  # dy : INT
    ctypes.c_int,  # dwData : INT
    ctypes.c_size_t,  # dwExtraInfo : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procmouse_event = user32.NewProc("mouse_event")
)

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

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

foreign import stdcall safe "mouse_event"
  c_mouse_event :: Word32 -> Int32 -> Int32 -> Int32 -> CUIntPtr -> IO ()
-- dwFlags : MOUSE_EVENT_FLAGS -> Word32
-- dx : INT -> Int32
-- dy : INT -> Int32
-- dwData : INT -> Int32
-- dwExtraInfo : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mouse_event =
  foreign "mouse_event"
    (uint32_t @-> int32_t @-> int32_t @-> int32_t @-> size_t @-> returning void)
(* dwFlags : MOUSE_EVENT_FLAGS -> uint32_t *)
(* dx : INT -> int32_t *)
(* dy : INT -> int32_t *)
(* dwData : INT -> int32_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 ("mouse_event" mouse-event :convention :stdcall) :void
  (dw-flags :uint32)   ; MOUSE_EVENT_FLAGS
  (dx :int32)   ; INT
  (dy :int32)   ; INT
  (dw-data :int32)   ; INT
  (dw-extra-info :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $mouse_event = Win32::API::More->new('USER32',
    'void mouse_event(DWORD dwFlags, int dx, int dy, int dwData, WPARAM dwExtraInfo)');
# my $ret = $mouse_event->Call($dwFlags, $dx, $dy, $dwData, $dwExtraInfo);
# dwFlags : MOUSE_EVENT_FLAGS -> DWORD
# dx : INT -> int
# dy : INT -> int
# dwData : INT -> int
# dwExtraInfo : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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