MbufGetHookInfo

• See also
User Guide:
Event handling in MIL with hook-handler functions Hooking to containers
Reference:
MbufChildMove MbufHookFunction
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)
Partially supported on:
Partially supported on Host system (a)
Partially supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)
Partially supported on Matrox Morphis (g)
Partially supported on Matrox Morphis QxT (h)
Partially supported on Matrox Orion HD (i)
Partially supported on Matrox Radient eCL (j)
Partially supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)
Partially supported on Matrox Solios eA/XA (l)
Partially supported on Matrox Solios ecl/xcl/ev-cl (m)
Partially supported on Matrox USB3 Vision driver (Update 19) (o)
Partially supported on Matrox RadientPro-CL (Update 7) (p)
Partially supported on Matrox Radient eV-CL (Update 27 or 74) (r)
Partially supported on Matrox Iris GTR (Update 28 or Update 68) (t)
Partially supported on Matrox Clarity UHD (Update 36 or 76) (u)
Partially supported on Matrox GenTL driver (Update 34) (v)
Partially supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)
Partially 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
None.
MbufGetColor
MbufGetLine

Description

Parameters

EventId

Specifies the buffer or container 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):

• array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
• 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	MIL system-specific tooltip (‡)
	UserVarPtr - Possible values returned
M_GC_FEATURE_CHANGE_NAME +		Retrieves the name of the GenICam feature that changed. This information type is only available if MbufGetHookInfo() is called from a function hooked to GenTL feature change events using MbufHookFunction() with M_FEATURE_CHANGE. (summarize) Retrieves the name of the GenICam feature that changed. (more details...)																					‡															v
	UserVarPtr extra info	Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MbufGetHookInfo ( M_GC_FEATURE_CHANGE_NAME + M_STRING_SIZE ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MbufGetHookInfo ( M_GC_FEATURE_CHANGE_NAME + M_STRING_SIZE ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size.	‡															v
	Value	Specifies the feature name.	‡															v
M_MODIFIED_BUFFER +		Retrieves information about a modified buffer or container 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 or container type of event. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	UserVarPtr extra info	Data type info: Data type: address of a void MORE Data type: address of a void Note: Data type is dependent on combination. Data type info: Data type: address of a void MORE Data type: address of a void Note: Data type is dependent on combination.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa

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
M_BUFFER_ID		Retrieves the MIL identifier of the modified buffer or container. (summarize) Retrieves the MIL identifier of the modified buffer or container. (more details...)																					‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	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	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
M_GRAB_TIME_STAMP		Inquires the time when MIL finished grabbing into the buffer, expressed in seconds. Typically, this will be in seconds since the Host computer was started. This can be used to see if a frame has been missed since the last time stamp. (summarize) Inquires the time when MIL finished grabbing into the buffer, expressed in seconds. (more details...)	‡			g	h		j	k M10	l	m		p	r U27	t U28				y U75		aa
	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	‡			g	h		j	k M10	l	m		p	r U27	t U28				y U75		aa
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	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	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	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	M_NO	Specifies that the buffer modification event was not triggered by a move operation.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	M_YES	Specifies that the buffer modification event was triggered by a move operation.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
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	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	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	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
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	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	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	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
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	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	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	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
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	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	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	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
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 XY-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 XY-size was changed. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	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	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	M_NO	Specifies that the buffer modification event was not triggered by a resize operation.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa
	M_YES	Specifies that the buffer modification event was triggered by a resize operation.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v		y U75		aa

Combination value for M_GC_FEATURE_CHANGE_NAME.

You can add the following value to the above-mentioned value to get the string's length.

For getting the string size
InfoType		Description	MIL system-specific tooltip (‡)
	UserVarPtr - Possible values returned
M_STRING_SIZE		Retrieves the length of the string, including the terminating null character ("\0"). (summarize) Retrieves the length of the string, including the terminating null character ("\0"). (more details...)																					‡															v
	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	‡															v

Return value

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