Loading Reference... User Guide... Hardware-specific Notes...

Customize Help

MIL systems:
Show All

Installed MIL systems

Multiple

None

Host system

Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)*

Matrox Morphis

Matrox Morphis QxT

Matrox Orion HD

Matrox Radient eCL

Matrox Radient eV-CXP (MIL 10 or Update 29)*

Matrox Solios eA/XA

Matrox Solios ecl/xcl/ev-cl

Matrox USB3 Vision driver (Update 19)

Matrox RadientPro-CL (Update 7)

Matrox Radient eV-CL (Update 27 or 74)

Matrox Iris GTR (Update 28 or Update 68)

Matrox Clarity UHD (Update 36 or 76)

Matrox GenTL driver (Update 34)

Matrox Indio (Update 53 or Update 68)

Matrox Rapixo CXP (Update 75 or Update 84)

Matrox Concord PoE with ToE (Update 82)

Matrox Rapixo CL Pro (Update 96)

As Tooltip

Value descriptions: Detailed Summarized

Save Settings

MobjGetHookInfo

See also

User Guide:

C/C++ MILweb function reference JavaScript MILweb function reference

Reference:

MobjHookFunction

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

mgraweb.cpp
webclient.cpp

Function Map

- EventId

Parameter Associations

Table:

For inquiring information

Return value

Compilation information

Synopsis

Get information about a hook event.

Syntax

MIL_INT MobjGetHookInfo(

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 function to be called. MobjGetHookInfo() should only be called within the scope of an object hook-handler function (see MobjHookFunction()).

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 if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

EventId

Specifies the object-related event identifier received by the hook-handler function (see MobjHookFunction()).

InfoType

Specifies the type of information about which to inquire.

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_ID

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 table below lists possible values for the InfoType parameter and possible values returned to the UserVarPtr parameter.

For inquiring information

For inquiring information
InfoType		Description
	UserVarPtr - Possible values returned	Description
M_OBJECT_ID		Inquires the object identifier that called the hook-handler function. (summarize) Inquires the object identifier that called the hook-handler function. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_ID Data type: address of a MIL_ID Data type info: Data type: address of a MIL_ID Data type: address of a MIL_ID
	Object identifier	Specifies the object identifier that called the hook-handler function.

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.