MthrInquire

See also

User Guide:

Multi-threading

Reference:

MsysAlloc MthrAlloc MthrControl

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 GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Partially supported on Matrox Orion HD (i)

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

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 Indio (Update 53 or Update 68) (w)

Partially supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

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 (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 RadientPro-CL (Update 7) (p)

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

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

None.

Function Map

- ThreadEventOrMutexId

Table:

For a user-allocated thread context or event

- InquireType

- UserVarPtr

Parameter Associations

Table:	For thread contexts
Table:	For MIL events
Table:	For mutexes

Return value

Compilation information

Synopsis

Inquire about a MIL thread context, event, or mutex setting.

Syntax

MIL_INT MthrInquire(

MIL_ID ThreadEventOrMutexId,	//in
MIL_INT64 InquireType,	//in
void *UserVarPtr	//out

)

Description

This function inquires about the specified MIL thread context, event setting, or mutex setting.

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

ThreadEventOrMutexId

Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc(). This parameter should be set to one of the following values:

For a user-allocated thread context or event
Value	Description
M_DEFAULT	Specifies the default MIL thread context identifier associated with the current Host thread.
MIL event identifier	Specifies the identifier of a user-allocated MIL event (MthrAlloc()).
MIL mutex identifier	Specifies the identifier of a user-allocated MIL mutex (MthrAlloc()).
MIL system identifier	Specifies the identifier of a valid system identifier (MsysAlloc()). When the parameter is set to the MIL identifier of a system, the function inquires about the current thread on the particular system. (summarize) Specifies the identifier of a valid system identifier (MsysAlloc()). (more details...)
MIL thread context identifier	Specifies the identifier of a user-allocated MIL thread context (MthrAlloc()).

InquireType

Specifies the type of information about which to inquire. This parameter can be set to one of the values below. See MthrControl() for more information about these values.

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_INT

Specifies the address in which to write the requested information. Since the MthrInquire() function also returns the requested information, you can set this parameter to M_NULL.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

For thread contexts
For MIL events
For mutexes

The following InquireType settings can be specified to inquire about MIL thread contexts.

For thread contexts
InquireType		Description	MIL system-specific tooltip (‡)
	UserVarPtr - Possible values returned	Description
M_ACCELERATOR		Inquires whether the thread uses hardware acceleration. SET (summarize) Inquires whether the thread uses hardware acceleration. SET (more details...)																					‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	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	w U53	y U75	z	aa
	M_DISABLE	Specifies not to use hardware acceleration.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
	M_ENABLE	Specifies to use hardware acceleration.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
M_BUS_MASTER_COPY_MODE		Inquires the synchronization mode for copy operations when they are driven by your imaging board (bus master). SET (summarize) Inquires the synchronization mode for copy operations when they are driven by your imaging board (bus master). SET (more details...)	‡			g	h		j	k M10	l	m		p	r U27					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	‡			g	h		j	k M10	l	m		p	r U27					y U75		aa
	M_ASYNCHRONOUS	Specifies that when possible, control will be returned to the imaging board (bus master) immediately after a copy operation is launched.	‡			g	h		j	k M10	l	m		p	r U27					y U75		aa
	M_SYNCHRONOUS	Specifies that the execution of a copy operation must be completed before returning control to the imaging board (bus master).	‡			g	h		j	k M10	l	m		p	r U27					y U75		aa
M_THREAD_MODE		Inquires the thread's execution mode. SET (summarize) Inquires the thread's execution mode. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	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	w U53	y U75	z	aa
	M_ASYNCHRONOUS	Specifies that the thread will execute in asynchronous mode, if possible. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
	M_SYNCHRONOUS	Specifies that the thread will execute in synchronous mode. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
M_THREAD_PRIORITY		Inquires the priority setting of the thread. SET (summarize) Inquires the priority setting of the thread. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	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	w U53	y U75	z	aa
	M_ABOVE_NORMAL	Specifies that the thread is above normal priority. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
	M_BELOW_NORMAL	Specifies that the thread is below normal priority. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
	M_IDLE	Specifies that the thread is idle. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
	M_LOWEST	Specifies that the thread is of the lowest priority. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
	M_NORMAL	Specifies that the thread is of normal priority. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa
	M_TIME_CRITICAL	Specifies that the thread is time critical. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	w U53	y U75	z	aa

The following InquireType settings can be specified to inquire about MIL events.

For MIL events
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_EVENT_MODE		Inquires the reset mode of the event. SET (summarize) Inquires the reset mode of the event. SET (more details...)
	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
	M_AUTO_RESET	Specifies that the event is reset automatically. INFO
	M_MANUAL_RESET	Specifies that the event is reset manually. INFO
M_EVENT_STATE		Inquires the state of the event. SET (summarize) Inquires the state of the event. SET (more details...)
	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
	M_NOT_SIGNALED	Specifies the not-signaled state.
	M_SIGNALED	Specifies the signaled state.

The following InquireType settings can be specified to inquire about MIL mutexes.

For mutexes
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_LOCK_TRY		Inquires whether the specified MIL mutex is locked by the current thread. (summarize) Inquires whether the specified MIL mutex is locked by the current thread. (more details...)
	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
	M_NO	Specifies that the current thread has not locked the specified mutex.
	M_YES	Specifies that the current thread has locked the specified mutex.

Return value

The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.