MbufGetHookInfo

Filters
See also

User Guide:

Event handling in MIL with hook-handler functions

Reference:

MbufChildMove MbufHookFunction

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Partially supported on:

Partially supported on Host system (a)

Partially supported on Matrox CronosPlus (b)

Partially supported on Matrox GigE Vision driver (c)

Partially supported on Matrox GPU processing driver (d)

Partially supported on Matrox IEEE 1394 IIDC driver (e)

Partially supported on Matrox Orion HD (i)

Partially supported on Matrox Vio (n)

Partially supported on Matrox USB3 Vision driver (requires Update 19) (o)

Partially supported on Matrox GigE Vision driver (requires Update 25) (s)

Fully supported on:

Fully supported on Matrox Iris GT (f)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (k)

Fully supported on Matrox Solios eA/XA (l)

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

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

Fully supported on Matrox Radient eV-CLHS (requires Update 21) (q)

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

Fully supported on Matrox Iris GTR (requires Update 28) (t)

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

None.

Function Map

- EventId

Parameter Associations

Table:	For the event type
+ combination:	For the modified buffer type of event

Return value

Compilation information

Synopsis

Get information about a hook event.

Syntax

MIL_INT MbufGetHookInfo(

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. MbufGetHookInfo() should only be called within the scope of a buffer hook-handler function (see MbufHookFunction()).

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

InfoType

Specifies 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_DOUBLE
MIL_ID
MIL_INT
a pointer of type void

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 the event type

For the event type
InfoType		Description
	UserVarPtr - Possible values returned	Description
M_MODIFIED_BUFFER +		Retrieves information about a modified buffer type of event. This event occurs if the hook-handler function was hooked using MbufHookFunction() with M_MODIFIED_BUFFER. You must specify a combination value from the following table: To set the type of information to return (summarize) Retrieves information about a modified buffer type of event. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a void (more details...) Data type: address of a void Note: Data type is dependent on combination. Data type info: Data type: address of a void (more details...) Data type: address of a void Note: Data type is dependent on combination.

Combination values for M_MODIFIED_BUFFER.

You must add one of the following values to the above-mentioned value to set the type of information to return.

For the modified buffer type of event
InfoType		Description	MIL system-specific tooltip (‡)
	UserVarPtr - Possible values returned	Description
M_BUFFER_ID		Retrieves the MIL identifier of the modified buffer. (summarize) Retrieves the MIL identifier of the modified buffer. (more details...)																							‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	UserVarPtr extra info	Data type info: Data type: address of a MIL_ID Data type info: Data type: address of a MIL_ID	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
M_GRAB_TIME_STAMP		Retrieves the time the event generated service request, in secs. The time can be used to see if a frame has been missed since the last time stamp. (summarize) Retrieves the time the event generated service request, in secs. (more details...)	‡						f	g	h		j	k	l	m			p	q	r		t
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE	‡						f	g	h		j	k	l	m			p	q	r		t
M_MOVED		Returns whether the buffer modification event was triggered by a move operation performed by MbufChildMove(); that is, the buffer is a child buffer and its X/Y offset was changed. (summarize) Returns whether the buffer modification event was triggered by a move operation performed by MbufChildMove(); that is, the buffer is a child buffer and its X/Y offset was changed. (more details...)	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	M_NO	Specifies that the buffer modification event was not triggered by a move operation.	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	M_YES	Specifies that the buffer modification event was triggered by a move operation.	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
M_REGION_OFFSET_X		Retrieves the X-offset of the modified region (of the buffer). (summarize) Retrieves the X-offset of the modified region (of the buffer). (more details...)	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
M_REGION_OFFSET_Y		Retrieves the Y-offset of the modified region (of the buffer). (summarize) Retrieves the Y-offset of the modified region (of the buffer). (more details...)	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
M_REGION_SIZE_X		Retrieves the width of the modified region (of the buffer). (summarize) Retrieves the width of the modified region (of the buffer). (more details...)	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
M_REGION_SIZE_Y		Retrieves the height of the modified region (of the buffer). (summarize) Retrieves the height of the modified region (of the buffer). (more details...)	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
M_RESIZED		Returns whether the buffer modification event was triggered by a resize operation performed by MbufChildMove(); that is; the buffer is a child buffer and its X/Y size was changed. (summarize) Returns whether the buffer modification event was triggered by a resize operation performed by MbufChildMove(); that is; the buffer is a child buffer and its X/Y size was changed. (more details...)	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	M_NO	Specifies that the buffer modification event was not triggered by a resize operation.	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u
	M_YES	Specifies that the buffer modification event was triggered by a resize operation.	‡	a	b	c	d	e	f	g	h	i	j	k	l	m	n	o	p	q	r	s	t	u