MseqGetHookInfo

See also

User Guide:

Setting your inputs and outputs

Reference:

MseqHookFunction MseqProcess

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Not 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

mseqprocess.cpp
mseqprocess.cs
mseqprocess.vb

Function Map

- EventId

Parameter Associations

Table:	For retrieving the information about a sequence hook event
+ combination:	For retrieving information about the internal output buffer

Return value

Compilation information

Synopsis

Get information about a sequence hook event.

Syntax

MIL_INT MseqGetHookInfo(

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

)

Description

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

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 sequence event identifier received by the hook-handler function. See MseqHookFunction() for more information.

InfoType

Specifies a combination of two values: the event type and 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_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 retrieving the information about a sequence hook event

For retrieving the information about a sequence hook event
InfoType		Description
	UserVarPtr - Possible values returned	Description
M_MODIFIED_BUFFER +		Retrieves information about a modified-buffer type of event. This event only occurs if the hook-handler function was hooked using MseqHookFunction(). You must specify a combination value from the following table: To get information about the internal output buffer (summarize) Retrieves information about a modified-buffer type of event. (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

Combination value for M_MODIFIED_BUFFER.

You must add the following value to the above-mentioned value to get information about the internal output buffer.

For retrieving information about the internal output buffer
InfoType		Description
	UserVarPtr - Possible values returned	Description
M_BUFFER_ID		Retrieves the MIL identifier of the internal output buffer modified by MseqProcess(). (summarize) Retrieves the MIL identifier of the internal output buffer modified by MseqProcess(). (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

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.