MfpgaGetHookInfo

Reference:

MfpgaHookFunction

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Host system

Matrox CronosPlus

Matrox GPU processing driver

Matrox GigE Vision driver

Matrox IEEE 1394 IIDC driver

Matrox Iris GT

Matrox Morphis

Matrox Morphis QxT

Matrox Orion HD

Matrox USB3 Vision driver (requires Update 19)

Matrox Vio

Fully supported on:

Matrox Radient eCL

Matrox Radient eV-CXP

Matrox Solios eA/XA

Matrox Solios ecl/xcl/ev-cl

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

Available on Matrox Supersight

Function Map

- EventId

Parameter Associations

Table:

For inquiring information

Return value

Compilation information

None.

MfpgaControl

MfpgaGetRegister

Synopsis

Get information about a PU hook event.

Syntax

MIL_INT MfpgaGetHookInfo(

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. The MfpgaGetHookInfo() function should only be called within the scope of a PU hook-handler function (see MfpgaHookFunction()).

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 PU event identifier received by the hook-handler function (see MfpgaHookFunction()).

InfoType

Specifies the type of information to get.

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

For inquiring information

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

For inquiring information
InfoType		Description	MIL system-specific tooltip (†)
	UserVarPtr - Possible values returned	Description
M_FPGA_DEVICE_NUMBER		Retrieves the device number of the Processing FPGA that contains the PU that triggered the event. This value corresponds to the rank of the Processing FPGA on the board, starting from 0. If there is only one Processing FPGA on board, then this value will be set to 0 by default. (summarize) Retrieves the device number of the Processing FPGA that contains the PU that triggered the event. (more details...)									†	j	k	l	m	p	q	r
M_FUNCTION_ID		Retrieves the function identifier of the PU that triggered the event. (summarize) Retrieves the function identifier of the PU that triggered the event. (more details...)	†	j	k	l	m	p	q	r
M_INSTANCE_ID		Retrieves the rank of the instance of the PU that triggered the event, when two or more instances, with the same function and subfunction identifier, are present in the loaded FPGA configuration. This value starts at 0. (summarize) Retrieves the rank of the instance of the PU that triggered the event, when two or more instances, with the same function and subfunction identifier, are present in the loaded FPGA configuration. (more details...)	†	j	k	l	m	p	q	r
M_SUB_FUNCTION_ID		Retrieves the subfunction identifier of the PU that triggered the event. (summarize) Retrieves the subfunction identifier of the PU that triggered the event. (more details...)	†	j	k	l	m	p	q	r
M_TIME_STAMP		Retrieves the time stamp of the event. (summarize) Retrieves the time stamp of the event. (more details...)	†	j	k	l	m	p	q	r
	UserVarPtr data type info	Data type: MIL_DOUBLE	†	j	k	l	m	p	q	r