| MIL 10 Reference
| Customize Help
| Save Settings

MthrInquire


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Partially supported on:
Partially supported on Host system
Partially supported on Matrox CronosPlus
Partially supported on Matrox GPU processing driver
Partially supported on Matrox GigE Vision driver
Partially supported on Matrox IEEE 1394 IIDC driver
Partially supported on Matrox Iris GT
Partially supported on Matrox Orion HD
Partially supported on Matrox USB3 Vision driver (requires Update 19)
Partially supported on Matrox Vio

Fully supported on:
Fully supported on Matrox Morphis
Fully supported on Matrox Morphis QxT
Fully supported on Matrox Radient eCL
Fully supported on Matrox Radient eV-CXP
Fully supported on Matrox Solios eA/XA
Fully supported on 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 Function map
Examples
MthrFree
MthrInquireMp
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:

function map For a user-allocated thread context or event
CollapseValue Description
Collapse M_DEFAULT

Specifies the default MIL thread context identifier associated with the current Host thread.
Collapse MIL event identifier

Specifies the identifier of a user-allocated MIL event (MthrAlloc()).
Collapse MIL mutex identifier

Specifies the identifier of a user-allocated MIL mutex (MthrAlloc()).
Collapse 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)
Collapse 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.

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

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

function map For thread contexts
CollapseInquireType Description
MIL system-specific
tooltip (†)
UserVarPtr
- Possible values returned
Collapse M_ACCELERATOR

Inquires whether the thread uses hardware acceleration. SET

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DISABLE

Specifies not to use hardware acceleration.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_ENABLE

Specifies to use hardware acceleration.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_BUS_MASTER_COPY_MODE

Inquires the synchronization mode for copy operations when they are driven by your imaging board (bus master). SET

(summarize)
† g h j k l m p q r
Collapse 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 l m p q r
Collapse 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 l m p q r
Collapse M_THREAD_MODE

Inquires the thread's execution mode. SET

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_ASYNCHRONOUS

Specifies that the thread will execute in asynchronous mode, if possible. INFO

 † a b c d e f g h i j k l m n o p q r s
Collapse M_SYNCHRONOUS

Specifies that the thread will execute in synchronous mode. INFO

 † a b c d e f g h i j k l m n o p q r s
Collapse M_THREAD_PRIORITY

Inquires the priority setting of the thread. SET

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_ABOVE_NORMAL

Specifies that the thread is above normal priority. INFO

 † a b c d e f g h i j k l m n o p q r s
Collapse M_BELOW_NORMAL

Specifies that the thread is below normal priority. INFO

 † a b c d e f g h i j k l m n o p q r s
Collapse M_IDLE

Specifies that the thread is idle. INFO

 † a b c d e f g h i j k l m n o p q r s
Collapse M_LOWEST

Specifies that the thread is of the lowest priority. INFO

 † a b c d e f g h i j k l m n o p q r s
Collapse M_NORMAL

Specifies that the thread is of normal priority. INFO

 † a b c d e f g h i j k l m n o p q r s
Collapse M_TIME_CRITICAL

Specifies that the thread is time critical. INFO

 † a b c d e f g h i j k l m n o p q r s

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

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

function map For MIL events
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_EVENT_MODE

Inquires the reset mode of the event. SET

(summarize)
Collapse M_AUTO_RESET

Specifies that the event is reset automatically. INFO
Collapse M_MANUAL_RESET

Specifies that the event is reset manually. INFO
Collapse M_EVENT_STATE

Inquires the state of the event. SET

(summarize)
Collapse M_NOT_SIGNALED

Specifies the not-signaled state.
Collapse M_SIGNALED

Specifies the signaled state.

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

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

function map For mutexes
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_LOCK_TRY

Inquires whether the specified MIL mutex is locked by the current thread.

(summarize)
Collapse M_NO

Specifies that the current thread has not locked the specified mutex.
Collapse 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.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
DEFAULT ACCELERATOR DISABLE ENABLE BUS MASTER COPY MODE ASYNCHRONOUS SYNCHRONOUS THREAD MODE ASYNCHRONOUS SYNCHRONOUS THREAD PRIORITY ABOVE NORMAL BELOW NORMAL IDLE LOWEST NORMAL TIME CRITICAL EVENT MODE AUTO RESET MANUAL RESET EVENT STATE NOT SIGNALED SIGNALED LOCK TRY NO YES