MdispGetHookInfo

See also

User Guide:

C/C++ MILweb function reference Fundamentals for creating your MILweb client application JavaScript MILweb function reference

Reference:

MdispHookFunction

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

alphablending.cpp
calibratedruler.cpp
charactercreator.cpp
cielabconversion.cpp
examplemanager.cpp
mdispgtkview.cpp
mdispmfcview.cpp
mdispqtview.cpp
mpmenu.cpp

Function Map

- EventId

Parameter Associations

Table:	For retrieving information regarding mouse events
Table:	For retrieving information regarding keyboard events
Table:	For retrieving information regarding either a mouse or keyboard event

Return value

Compilation information

Synopsis

Get information about a display hook event.

Syntax

MIL_INT MdispGetHookInfo(

MIL_ID EventId,	//in
MIL_INT64 InfoType,	//in
void *UserVarPtr	//out

)

Description

This function allows you to get information about the event that caused the hook-handler function to be called. MdispGetHookInfo() should only be called within the scope of a display hook-handler function (see MdispHookFunction()).

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

EventId

Specifies the display event identifier received by the hook-handler function (see MdispHookFunction()).

InfoType

Specifies the type of information about the event to return.

See the Parameter associations section for possible values that can be specified.

UserVarPtr

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

MIL_DOUBLE
MIL_INT

Specifies the address in which to write the requested information.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the InfoType parameter and possible values returned to the UserVarPtr parameter.

For retrieving information regarding mouse events
For retrieving information regarding keyboard events
For retrieving information regarding either a mouse or keyboard event

If the hook-handler function was called due to an M_MOUSE_... event type, the InfoType parameter can be set to one of the values below.

For retrieving information regarding mouse events
InfoType		Description
	UserVarPtr - Possible values returned	Description
M_MOUSE_POSITION_BUFFER_X		Retrieves the X-position of the cursor, in buffer coordinates. (summarize) Retrieves the X-position of the cursor, in buffer coordinates. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	Value	Specifies the X-position of the cursor, in buffer coordinates.
M_MOUSE_POSITION_BUFFER_Y		Retrieves the Y-position of the cursor, in buffer coordinates. (summarize) Retrieves the Y-position of the cursor, in buffer coordinates. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	Value	Specifies the Y-position of the cursor, in buffer coordinates.
M_MOUSE_POSITION_X		Retrieves the X-position of the cursor, in display coordinates. (summarize) Retrieves the X-position of the cursor, in display coordinates. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the X-position of the cursor, in display coordinates.
M_MOUSE_POSITION_Y		Retrieves the Y-position of the cursor, in display coordinates. (summarize) Retrieves the Y-position of the cursor, in display coordinates. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the Y-position of the cursor, in display coordinates.
M_MOUSE_WHEEL_VALUE		Retrieves the value for the mouse wheel's rotation. Note, this value can only be retrieved if the hook-handler function was called due to the M_MOUSE_WHEEL event. (summarize) Retrieves the value for the mouse wheel's rotation. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the value for the mouse wheel's rotation. A positive value indicates that the wheel was rotated forward, away from the user; a negative value indicates that the wheel was rotate backward, toward the user. (summarize) Specifies the value for the mouse wheel's rotation. (more details...)

If the hook-handler function was called due to an M_KEY_... event type, the InfoType parameter can be set to the value below.

For retrieving information regarding keyboard events
InfoType		Description
	UserVarPtr - Possible values returned	Description
M_KEY_VALUE		Retrieves the operating system's key code for the keyboard key that triggered the event. (summarize) Retrieves the operating system's key code for the keyboard key that triggered the event. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the key code.
M_MIL_KEY_VALUE		Retrieves the MIL operating system-independent key code for the keyboard key that triggered the event. Note, this value can only be retrieved if the hook-handler function was called due to the M_KEY_DOWN or M_KEY_UP event. (summarize) Retrieves the MIL operating system-independent key code for the keyboard key that triggered the event. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_KEY_ADD	Specifies the Add key (+).
	M_KEY_ARROW_DOWN	Specifies the Down Arrow key.
	M_KEY_ARROW_LEFT	Specifies the Left Arrow key.
	M_KEY_ARROW_RIGHT	Specifies the Right Arrow key.
	M_KEY_ARROW_UP	Specifies the Up Arrow key.
	M_KEY_BACK	Specifies the Back key.
	M_KEY_CLEAR	Specifies the Clear key.
	M_KEY_DECIMAL	Specifies the Period key located on your number pad.
	M_KEY_DELETE	Specifies the Delete key.
	M_KEY_DIVIDE	Specifies the Divide key (/).
	M_KEY_END	Specifies the End key.
	M_KEY_ESC	Specifies the Esc key.
	M_KEY_EXECUTE	Specifies the Execute key.
	M_KEY_Fn	Specifies the n key, where n is a value from 1 to 24.
	M_KEY_HOME	Specifies the Home key.
	M_KEY_INSERT	Specifies the Insert key.
	M_KEY_MULTIPLY	Specifies the Multiply key (*).
	M_KEY_n	Specifies the n key, where n is a value from 0 to 9.
	M_KEY_NUM_LOCK	Specifies the Num Lock key.
	M_KEY_NUMPADn	Specifies the n key, where n is a value from 0 to 9.
	M_KEY_PAGEDOWN	Specifies the Pagedown key.
	M_KEY_PAGEUP	Specifies the Pageup key.
	M_KEY_PAUSE	Specifies the Pause key.
	M_KEY_RETURN	Specifies the Return key (Enter).
	M_KEY_SCROLL_LOCK	Specifies the Scroll Lock key.
	M_KEY_SEPARATOR	Specifies the Separator key.
	M_KEY_SPACE	Specifies the Space key.
	M_KEY_SUBTRACT	Specifies the Subtract key (-).
	M_KEY_TAB	Specifies the Tab key.
	M_KEY_xxx	Specifies the letter key xxx, where xxx can be a letter from A to Z.

If the hook-handler function was called due to either an M_KEY_... or M_MOUSE_... event type, the InfoType parameter can be set to the value below.

For retrieving information regarding either a mouse or keyboard event
InfoType		Description
	UserVarPtr - Possible values returned	Description
M_COMBINATION_KEYS		Retrieves which combination keys or mouse buttons triggered the event. Note that a combination of the values below can be returned. Bitwise operators must be used to establish the specific keys or buttons pressed. (summarize) Retrieves which combination keys or mouse buttons triggered the event. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT MORE Data type: address of a MIL_INT Bitwise return value; values listed below can be established using bitwise operators. Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT MORE Data type: address of a MIL_INT Bitwise return value; values listed below can be established using bitwise operators. Data type: address of a MIL_INT
	M_KEY_ALT	Specifies the Alt key.
	M_KEY_CTRL	Specifies the Ctrl key.
	M_KEY_SHIFT	Specifies the Shift key.
	M_KEY_WIN	Specifies the Windows key.
	M_MOUSE_LEFT_BUTTON	Specifies the left mouse button.
	M_MOUSE_MIDDLE_BUTTON	Specifies the middle mouse button.
	M_MOUSE_RIGHT_BUTTON	Specifies the right mouse button.

Return value

The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll; mildisplay.dll.