ホーム › UI.Input.KeyboardAndMouse › TrackMouseEvent

TrackMouseEvent

関数

マウスのホバーやウィンドウ離脱イベントを追跡する。

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

シグネチャ

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

BOOL TrackMouseEvent(
    TRACKMOUSEEVENT* lpEventTrack
);

パラメーター

名前	型	方向	説明
lpEventTrack	TRACKMOUSEEVENT*	inout	トラッキング情報を格納した TRACKMOUSEEVENT 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

マウスポインターがウィンドウから離れたとき、または指定した時間だけウィンドウ上にとどまったときにメッセージを送信します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

マウスポインターが指定した矩形内に指定した時間だけとどまっている場合、ホバー状態とみなされます。 SystemParametersInfo を呼び出し、SPI_GETMOUSEHOVERWIDTH、SPI_GETMOUSEHOVERHEIGHT、SPI_GETMOUSEHOVERTIME の値を使用して、矩形のサイズと時間を取得できます。

この関数は次のメッセージを送信できます。

メッセージ	説明
WM_NCMOUSEHOVER	WM_MOUSEHOVER と同じ意味ですが、こちらはウィンドウの非クライアント領域に対するものです。
WM_NCMOUSELEAVE	WM_MOUSELEAVE と同じ意味ですが、こちらはウィンドウの非クライアント領域に対するものです。
WM_MOUSEHOVER	マウスが、事前の TrackMouseEvent 呼び出しで指定した時間だけ、ウィンドウのクライアント領域上にホバーしました。このメッセージが生成されると、ホバートラッキングは停止します。マウスのホバー動作をさらにトラッキングする必要がある場合、アプリケーションは TrackMouseEvent を再度呼び出す必要があります。
WM_MOUSELEAVE	マウスが、事前の TrackMouseEvent 呼び出しで指定したウィンドウのクライアント領域から離れました。このメッセージが生成されると、TrackMouseEvent によって要求されたすべてのトラッキングがキャンセルされます。マウスのホバー動作をさらにトラッキングする必要がある場合、アプリケーションはマウスがウィンドウに再び入った時点で TrackMouseEvent を呼び出す必要があります。

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

各言語での呼び出し定義

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

BOOL TrackMouseEvent(
    TRACKMOUSEEVENT* lpEventTrack
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TrackMouseEvent(
    IntPtr lpEventTrack   // TRACKMOUSEEVENT* in/out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TrackMouseEvent(
    lpEventTrack As IntPtr   ' TRACKMOUSEEVENT* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpEventTrack : TRACKMOUSEEVENT* in/out
Declare PtrSafe Function TrackMouseEvent Lib "user32" ( _
    ByVal lpEventTrack As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TrackMouseEvent = ctypes.windll.user32.TrackMouseEvent
TrackMouseEvent.restype = wintypes.BOOL
TrackMouseEvent.argtypes = [
    ctypes.c_void_p,  # lpEventTrack : TRACKMOUSEEVENT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
TrackMouseEvent = Fiddle::Function.new(
  lib['TrackMouseEvent'],
  [
    Fiddle::TYPE_VOIDP,  # lpEventTrack : TRACKMOUSEEVENT* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn TrackMouseEvent(
        lpEventTrack: *mut TRACKMOUSEEVENT  // TRACKMOUSEEVENT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool TrackMouseEvent(IntPtr lpEventTrack);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_TrackMouseEvent' -Namespace Win32 -PassThru
# $api::TrackMouseEvent(lpEventTrack)

#uselib "USER32.dll"
#func global TrackMouseEvent "TrackMouseEvent" sptr
; TrackMouseEvent varptr(lpEventTrack)   ; 戻り値は stat
; lpEventTrack : TRACKMOUSEEVENT* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global TrackMouseEvent "TrackMouseEvent" var
; res = TrackMouseEvent(lpEventTrack)
; lpEventTrack : TRACKMOUSEEVENT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global TrackMouseEvent "TrackMouseEvent" sptr
; res = TrackMouseEvent(varptr(lpEventTrack))
; lpEventTrack : TRACKMOUSEEVENT* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。