Click here to show toolbars of the Web Online Help System: show toolbars
 

Filters
Filter values by
System Settings
  • Timer and counter settings
  • Digital I/O settings
  • Hardware health
  • Hardware identification
  • Hardware resources available
  • Rotary decoder settings
  • Action group settings
  • Thread and timeout settings
  • UART settings
  • Watchdog settings
| Customize Help
| Save Settings

MsysInquire


Function Map
Syntax
Description
Parameters
- SysId
Table: For the system identifier
- InquireType
- UserVarPtr
Parameter Associations
Table: For general system settings
+ combination: Returns the number of hook threads that were allocated
+ combination: For specifying the acquisition path to inquire
Table: For inquiring I/O signals and their mode
+ combination: For inquiring the type and number of the I/O signal
+ combination: For specifying the type of I/O signal to inquire
Table: For inquiring the state of specified user-bits in a static-user-output register
+ combination: For inquiring the bit in the static-user-output register
Table: For inquiring the settings of a timer
+ combination: For specifying which on-board timer to inquire
+ combination: For specifying which I/O command register bit was used
+ combination: For inquiring the maximum or minimum value for the setting
Table: For inquiring the settings of a rotary decoder
+ combination: For specifying which rotary decoder to inquire about
Table: For UART settings
+ combination: For COM Ports and UARTs
Table: For Watchdog settings
Table: For inquiring action commands
+ combination: For specifying which action command to control
Return value
Remarks
Examples
Compilation information
Synopsis
Inquire about a system setting.
Syntax
MIL_INT MsysInquire(
MIL_ID SysId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about the specified system setting.

Note that you can use MsysControl() to control specific system settings.

You can also interactively inquire most of the system settings in real-time, using Matrox Intellicam's Feature Browser.

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
SysId

Specifies the system identifier. This parameter should be set to one of the following values:

function map For the system identifier
Click to summarizeValue Description
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Click to summarize MIL system identifier

Specifies a valid system identifier, which you have allocated using the MsysAlloc() function.
InquireType

Specifies the type of system setting about which to inquire.

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
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MsysInquire() 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 inquire types allow you to inquire general system settings.

function map For general system settings
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_ACCELERATOR_PRESENT

Inquires whether the processing accelerator is present.

(summarize)
‡ j k l m p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k l m p q r
Click to summarize M_NO

Specifies that the processing accelerator is not present.

 ‡ j k l m p q r
Click to summarize M_YES

Specifies that the processing accelerator is present.

 ‡ j k l m p q r
Click to summarize M_ALLOCATION_OVERSCAN

Inquires whether image buffers, allocated on the system, will be allocated with an overscan region. SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_DISABLE

Specifies that image buffers allocated on the system will have no overscan region.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_ENABLE

Specifies that image buffers are allocated on the system with an overscan region.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_ALLOCATION_OVERSCAN_SIZE

Inquires the size of the overscan region, added around all subsequently allocated image buffers (MbufAlloc...()). SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize Value

Specifies the size of the overscan region, in pixels. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_ASYNCHRONOUS_CALL_SUPPORT

Inquires whether the system supports asynchronous function execution or not.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_NO

Specifies that the system does not support asynchronous execution.

 ‡ a b c e o s
Click to summarize M_YES

Specifies that the system supports asynchronous execution.

 ‡ d f g h i j k l m n p q r t u
Click to summarize M_BOARD_REVISION

Inquires the board revision number.

(summarize)
‡ a b f g h i j k l m n p q r t u
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b f g h i j k l m n p q r t u
Click to summarize Value

Specifies the board revision number.

 ‡ a b f g h i j k l m n p q r t u
Click to summarize M_BOARD_SUB_REVISION

Inquires the board sub-revision number.

(summarize)
‡ a f t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a f t
Click to summarize Value

Specifies the board sub-revision number.

 ‡ a f t
Click to summarize M_BOARD_TYPE

Inquires the type of system board.

To return only the main board type and not the sub-board types (for example, to get M_SOLIOS without M_XCL, M_FAST, or M_DBCL), mask the return value with M_BOARD_TYPE_MASK. For an example of how to use this mask, refer to the examples below.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_CRONOSPLUS

Specifies a Matrox CronosPlus board.

 ‡ b
Click to summarize M_GIGE_VISION

Specifies a camera that uses the Matrox GigE Vision driver.

 ‡ c s
Click to summarize M_GPU

Specifies a board that uses the Matrox GPU driver.

 ‡ d
Click to summarize M_HOST
[This is only applicable to Non-Matrox computer platform]

Specifies a host system.

 ‡ a
Click to summarize M_HOST+ M_4SIGHT + M_4SIGHT_GP
[This is only applicable to Matrox 4Sight GP/GPm platform]

Specifies a Matrox 4Sight GP with a Host system.

 ‡ a
Click to summarize M_HOST+ M_4SIGHT + M_4SIGHT_GPM
[This is only applicable to Matrox 4Sight GP/GPm platform]

Specifies a Matrox 4Sight GPm with a Host system.

 ‡ a
Click to summarize M_HOST+ M_4SIGHT + M_4SIGHT_X
[This is only applicable to Matrox 4Sight-X platform]

Specifies a Matrox 4Sight X with a Host system.

 ‡ a
Click to summarize M_HOST + M_SUPERSIGHT
[This is only applicable to Matrox Supersight platform]

Specifies a Matrox SuperSight with a host system.

 ‡ a
Click to summarize M_IEEE_1394_IIDC

Specifies a board that uses the Matrox IEEE 1394 IIDC driver.

 ‡ e
Click to summarize M_IEEE_1394_IIDC + M_CONCORD

Specifies a Concord F-Series adaptor board.

 ‡ e
Click to summarize M_IRIS_GT + M_GT300

Specifies a Matrox Iris GT 300.

 ‡ f
Click to summarize M_IRIS_GTR

Specifies a Matrox Iris GTR.

 ‡ t
Click to summarize M_IRIS + M_GT1200

Specifies a Matrox Iris GT 1200.

 ‡ f
Click to summarize M_IRIS + M_GT1900

Specifies a Matrox Iris GT 1900.

 ‡ f
Click to summarize M_MORPHIS + M_2VD + M_IO

Specifies a Matrox Morphis board with two video decoders and the I/O module.

 ‡ g
Click to summarize M_MORPHISQXT + M_4VD + M_IO

Specifies a Matrox Morphis QxT board with four video decoders and the I/O module.

 ‡ h
Click to summarize M_MORPHISQXT + M_16VD + M_IO

Specifies a Matrox Morphis QxT analog color/monochrome x4 PCIe frame grabber board with 16 video decoders.

 ‡ h
Click to summarize M_ORION_HD

Specifies a Matrox Orion HD board.

 ‡ i u
Click to summarize M_RADIENT + M_CL + M_DBCL

Specifies a Matrox Radient eV-CL dual-Base Camera Link board.

 ‡ r
Click to summarize M_RADIENT + M_CL + M_DBCL + M_PF

Specifies a Matrox Radient eCL dual-Base Camera Link board with a customizable FPGA-based processing core.

 ‡ j
Click to summarize M_RADIENT + M_CL + M_DFCL

Specifies a Matrox Radient eV-CL dual-Full Camera Link board.

 ‡ r
Click to summarize M_RADIENT + M_CL + M_DFCL + M_PF

Specifies a Matrox Radient eCL dual-Full Camera Link board with a customizable FPGA-based processing core.

 ‡ j
Click to summarize M_RADIENT + M_CL + M_QBCL

Specifies a Matrox Radient eV-CL quad-Base Camera Link board.

 ‡ r
Click to summarize M_RADIENT + M_CL + M_QBCL + M_PF

Specifies a Matrox Radient eCL quad-Base Camera Link board with a customizable FPGA-based processing core.

 ‡ j
Click to summarize M_RADIENT + M_CL + M_SFCL

Specifies a Matrox Radient eV-CL single-Full Camera Link board.

 ‡ r
Click to summarize M_RADIENT + M_CL + M_SFCL + M_PF

Specifies a Matrox Radient eCL single-Base Camera Link board with a customizable FPGA-based processing core.

 ‡ j
Click to summarize M_RADIENT + M_CLHS + M_SC7MS3

Specifies a Matrox Radient ev-CLHS board.

 ‡ q
Click to summarize M_RADIENT + M_CXP + M_D3G

Specifies a Matrox Radient eV-CXP Dual Q3G board.

 ‡ k
Click to summarize M_RADIENT + M_CXP + M_D6G

Specifies a Matrox Radient eV-CXP Dual Q6G board.

 ‡ k
Click to summarize M_RADIENT + M_CXP + M_Q3G

Specifies a Matrox Radient eV-CXP Quad Q3G board.

 ‡ k
Click to summarize M_RADIENT + M_CXP + M_Q6G

Specifies a Matrox Radient eV-CXP Quad Q6G board.

 ‡ k
Click to summarize M_RADIENTPRO + M_CL + M_DBCL + M_PF

Specifies a Matrox Radient Pro dual-Base Camera Link board with a customizable FPGA-based processing core.

 ‡ p
Click to summarize M_RADIENTPRO + M_CL + M_SFCL + M_PF

Specifies a Matrox Radient Pro single-Base Camera Link board with a customizable FPGA-based processing core.

 ‡ p
Click to summarize M_SOLIOS + M_XA + M_DA

Specifies a Matrox Solios eA/XA dual analog board.

 ‡ l
Click to summarize M_SOLIOS + M_XA + M_QA

Specifies a Matrox Solios eA/XA quad analog board.

 ‡ l
Click to summarize M_SOLIOS + M_XA + M_SA

Specifies a Matrox Solios eA/XA single analog board.

 ‡ l
Click to summarize M_SOLIOS + M_XCL + M_DBCL

Specifies a Matrox Solios eCL/XCL dual-Base Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_DBCL + M_FAST

Specifies a Matrox Solios eCL/XCL dual-Base fast Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_DBCL + M_PF

Specifies a Matrox Solios eCL/XCL dual-Base Camera Link board with a customizable FPGA-based processing core.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SBCL

Specifies a Matrox Solios eCL/XCL single-Base Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SBCL + M_FAST

Specifies a Matrox Solios eCL/XCL single-Base fast Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SBCL + M_PF

Specifies a Matrox Solios eCL/XCL single-Base Camera Link board with a customizable FPGA-based processing core.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SFCL

Specifies a Matrox Solios eCL/XCL single-Full Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SFCL + M_FAST

Specifies a Matrox Solios eCL/XCL single-Full fast Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SFCL + M_PF

Specifies a Matrox Solios eCL/XCL single-Full Camera Link board with a customizable FPGA-based processing core.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SMCL

Specifies a Matrox Solios eCL/XCL single-Medium Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SMCL + M_FAST

Specifies a Matrox Solios eCL/XCL single-Medium fast Camera Link board.

 ‡ m
Click to summarize M_SOLIOS + M_XCL + M_SMCL + M_PF

Specifies a Matrox Solios eCL/XCL single-Medium Camera Link board with a customizable FPGA-based processing core.

 ‡ m
Click to summarize M_USB3_VISION

Specifies a camera that uses the Matrox USB3 Vision driver.

 ‡ o
Click to summarize M_VIO + M_SA

Specifies a Matrox Vio Analog board.

 ‡ n
Click to summarize M_VIO + M_SA + M_DVI

Specifies a Matrox Vio DVI-A board.

 ‡ n
Click to summarize M_VIO + M_SA + M_SDI

Specifies a Matrox Vio Duo board.

 ‡ n
Click to summarize M_CURRENT_THREAD_ID

Inquires the identifier of the current system thread. This identifier can be used with the thread module.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_DCF_SUPPORTED

Inquires whether the system supports downloadable digitizer configuration format (DCF) files.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_FALSE

Specifies that DCF files are not supported.

 ‡ a d t
Click to summarize M_TRUE

Specifies that DCF files are supported.

 ‡ b c e f g h i j k l m n o p q r s u
Click to summarize M_DEFAULT_PITCH_BYTE_MULTIPLE

Inquires the pitch (or stride) multiple (in bytes) for the buffers allocated on the system. SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize Value

Specifies the pitch multiple, in bytes. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_DIGITIZER_NUM

Inquires the total number of possible independent acquisition paths on the system. Note that this is not the same as the total number of allocated acquisition paths on the system.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
MIL system specific

Inquires the total number of GigE Vision cameras discovered.

 ‡ c o s
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize Value >= 0

Specifies the number of independent acquisition paths available.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_DIGITIZER_TYPE +

Inquires the type of frame grabber(s) available to allocate a digitizer on the system.

(summarize)
‡ a f t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a f t
Click to summarize M_300

Specifies a Matrox Iris GTR 300.

 ‡ t
Click to summarize M_300C

Specifies a Matrox Iris GTR 300C.

 ‡ t
Click to summarize M_1300

Specifies a Matrox Iris GTR 1300.

 ‡ t
Click to summarize M_1300C

Specifies a Matrox Iris GTR 1300C.

 ‡ t
Click to summarize M_2000

Specifies a Matrox Iris GTR 2000.

 ‡ t
Click to summarize M_2000C

Specifies a Matrox Iris GTR 2000C.

 ‡ t
Click to summarize M_5000

Specifies a Matrox Iris GTR 5000.

 ‡ t
Click to summarize M_5000C

Specifies a Matrox Iris GTR 5000C.

 ‡ t
Click to summarize M_GT300

Specifies a Matrox Iris GT300 or a Matrox 4SightGP GT 300.

(summarize)
‡ a f
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

Note that a host system is only available with the Matrox 4SightGP GT 300.

 ‡ a
Click to summarize M_GT1200

Specifies a Matrox Iris GT1200.

 ‡ f
Click to summarize M_GT1900

Specifies a Matrox Iris GT1900.

 ‡ f
Click to summarize M_DISPLAY_OUTPUT_NUM

Inquires the number of video output controllers available on your Matrox imaging board.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize Value >= 0

Specifies the number of video output controllers.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_EXTENDED_INIT_FLAG

Inquires the system initialization flag. SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_DEFAULT

Same as M_COMPLETE.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_COMPLETE

Specifies to initialize the system completely; the system is initialized to its default state and any required resident software is downloaded. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_PARTIAL

Specifies to initialize the system to its default state, but it does not download any resident software. INFO

 ‡ d
Click to summarize M_FIRMWARE_BUILDDATE

Inquires the date when the grab firmware was built.

(summarize)
‡ a f g h i j k l m n p q r t u
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a f g h i j k l m n p q r t u
Click to summarize Value

Specifies the grab firmware build date.

 ‡ a f g h i j k l m n p q r t u
Click to summarize M_FIRMWARE_BUILDDATE_PROCESSING

Inquires the date when the processing firmware was built.

(summarize)
‡ j l m
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j l m
Click to summarize Value

Specifies the processing firmware build date.

 ‡ j l m
Click to summarize M_FIRMWARE_REVISION

Inquires the revision number of the grab firmware.

(summarize)
‡ a f g h i j k l m n p q r t u
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a f g h i j k l m n p q r t u
Click to summarize Value

Specifies the grab firmware revision number.

 ‡ a f g h i j k l m n p q r t u
Click to summarize M_FIRMWARE_REVISION_PROCESSING

Inquires the revision number of the processing firmware.

(summarize)
‡ j m
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j m
Click to summarize Value

Specifies the grab firmware revision number.

 ‡ j m
Click to summarize M_GC_FEATURE_EXECUTE_POLLING_MODE

Inquires whether to automatically perform execution-complete polling on executable camera features. SET

(summarize)
‡ q s
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ q s
Click to summarize M_AUTOMATIC

Specifies that the specific executable camera feature is executed synchronously.

 ‡ q s
Click to summarize M_MANUAL

Specifies that the specific executable camera feature is executed asynchronously.

 ‡ q s
Click to summarize M_GENICAM_AVAILABLE

Inquires whether the system supports a GenICam-compatible device (such as a GigE Vision device).

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_FALSE

Specifies that GenICam is not available.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_TRUE

Specifies that GenICam is available.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_GRAB_FPGA_FAN_RPM

Inquires the revolutions per minute (RPM) of the grab firmware's fan.

(summarize)
‡ k q
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ k q
Click to summarize Value

Specifies the speed of the grab firmware's fan, in RPM.

 ‡ k q
Click to summarize M_LED_USER

Inquires the color of the user LED on your Matrox Iris GTR. SET

(summarize)
‡ t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ t
Click to summarize M_GREEN

Specifies to turn the user LED green.

 ‡ t
Click to summarize M_OFF

Specifies to turn the user LED off.

 ‡ t
Click to summarize M_ORANGE

Specifies to turn the user LED orange.

 ‡ t
Click to summarize M_RED

Specifies to turn the user LED red.

 ‡ t
Click to summarize M_LOCATION

Inquires the location of the specified system.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_LOCAL

Specifies that the system is on the master computer.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_REMOTE

Specifies that the system is on the remote computer.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_MEMORY_FREE

Inquires the total amount of free on-board memory. Note that this memory might not be contiguous.

(summarize)
‡ g h j k l m n p q r
MIL system specific

Note that, if the specified system is a Matrox Solios eCL/XCL with Processing FPGA, the dedicated Processing FPGA memory is included in the amount returned.

 ‡ m
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h j k l m n p q r
Click to summarize Value

Specifies the amount of free on-board memory, in bytes.

 ‡ g h j k l m n p q r
Click to summarize M_MEMORY_FREE_BANK_0

Inquires the total amount of free on-board memory the first SDRAM bank. Note that this memory might not be contiguous.

(summarize)
‡ j k l m p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k l m p q r
Click to summarize Value

Specifies the amount of free on-board memory in the first SDRAM bank, in bytes.

 ‡ j k l m p q r
Click to summarize M_MEMORY_FREE_BANK_1

Inquires the total amount of free on-board memory second SDRAM bank. Note that this memory might not be contiguous.

(summarize)
‡ j m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j m p r
Click to summarize Value

Specifies the amount of free on-board memory second SDRAM bank, in bytes.

 ‡ j m p r
Click to summarize M_MEMORY_FREE_BANK_2

Inquires the total amount of free on-board memory in the third SDRAM bank. Note that this memory might not be contiguous.

(summarize)
‡ m
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ m
Click to summarize Value

Specifies the amount of free on-board memory in the third SDRAM bank, in bytes.

 ‡ m
Click to summarize M_MEMORY_SIZE

Inquires the amount of on-board memory.

(summarize)
‡ g h i j k l m n p q r u
MIL system specific

Note that, if the specified system is a Matrox Solios eCL/XCL with Processing FPGA, the dedicated Processing FPGA memory is included in the amount returned.

 ‡ m
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h i j k l m n p q r u
Click to summarize Value

Specifies the total amount of on-board memory, in Mbytes.

 ‡ g h i j k l m n p q r u
Click to summarize M_MEMORY_SIZE_BANK_0

Inquires the total amount of on-board shared memory in the first SDRAM bank.

(summarize)
‡ j k l m p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k l m p q r
Click to summarize Value

Specifies the total amount of on-board shared memory in the first SDRAM bank, in Mbytes.

 ‡ j k l m p q r
Click to summarize M_MEMORY_SIZE_BANK_1

Inquires the total amount of on-board shared memory.

(summarize)
‡ j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j l m p r
Click to summarize Value

Specifies the total amount of on-board shared memory, in Mbytes.

(summarize)
‡ j l m p r
MIL system specific

This is the second bank of SDRAM.

 ‡ l m

This is a bank of SRAM.

 ‡ j p r
Click to summarize M_MEMORY_SIZE_BANK_2

Inquires the total amount of on-board shared memory in the second SRAM bank.

(summarize)
‡ l m
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ l m
Click to summarize Value

Specifies the total amount of on-board shared memory in the second SRAM bank, in Mbytes.

 ‡ l m
Click to summarize M_MODIFIED_BUFFER_HOOK_MODE

Inquires whether to run user-defined functions hooked to a buffer modification on separate threads, up to the number of CPU cores present in the computer. SET

(summarize)
‡ c g h i j k l m n o p q r s u
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c g h i j k l m n o p q r s u
Click to summarize M_MULTI_THREAD +

Specifies to run user-defined functions hooked to a buffer modification on separate threads. INFO

 ‡ c g h i j k l m n o p q r s u
Click to summarize M_SINGLE_THREAD

Specifies that only one thread should be created and that all user-defined functions hooked to buffer modifications are run on the same thread.

 ‡ c g h i j k l m n o p q r s u
Click to summarize M_NUM_CAMERA_PRESENT

Inquires the number of GigE Vision-compliant cameras connected to the allocated system.

(summarize)
‡ c o s
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ c o s
Click to summarize Value

Specifies the number of GigE Vision-compliant cameras.

 ‡ c o s
Click to summarize M_NUMBER

Inquires the board number of the system. SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_DEVn

Specifies the n th board of the specified system type. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_OWNER_APPLICATION

Inquires the MIL identifier of the application context in which the system has been allocated.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize MIL application ID

Specifies the MIL application context identifier.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_PCIE_NUMBER_OF_LANES

Inquires the number of PCIe lanes that are currently active.

(summarize)
‡ j k p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k p q r
Click to summarize 1; 2; 4; 8; 16

Specifies the number of active lanes.

 ‡ j k p q r
Click to summarize M_PCIE_NUMBER_OF_LANES_MAX

Inquires the total number of PCIe lanes that your board can use.

(summarize)
‡ p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ p q r
Click to summarize 1; 2; 4; 8; 16

Specifies the total number of lanes.

 ‡ p q r
Click to summarize M_PCIE_SPEED

Inquires the negotiated generation of the PCIe standard currently being used by the active PCIe lanes. For example, if your board is a PCIe 3.0 device, but it is connected to a PCIe 2.0 device, this inquire type returns M_GEN2.

To establish the current PCIe speed for your board, use the following equation: M_PCIE_NUMBER_OF_LANES x 2 x speed of PCIe generation

(summarize)
‡ p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ p q r
Click to summarize M_GENn

Specifies the PCIe generation, where n is a value from 1 to 3.

 ‡ p q r
Click to summarize M_INVALID

Specifies that the PCIe generation cannot be returned.

 ‡ p q r
Click to summarize M_PCIE_SPEED_MAX

Inquires the generation of the PCIe standard for your board. For example, if your board is a PCIe 3.0 device, this inquire type returns M_GEN3.

To establish the maximum PCIe speed for your board, use the following equation: M_PCIE_NUMBER_OF_LANES_MAX x 2 x maximum speed of PCIe generation

(summarize)
‡ p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ p q r
Click to summarize M_GENn

Specifies the PCIe generation, where n is a value from 1 to 3.

 ‡ p q r
Click to summarize M_INVALID

Specifies that the PCIe generation cannot be returned.

 ‡ p q r
Click to summarize M_PROCESSING_FPGA_FAN_RPM

Inquires the revolutions per minute (RPM) of the processing firmware's fan.

(summarize)
‡ j p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j p r
Click to summarize Value

Specifies the speed of the processing firmware's fan, in RPM.

 ‡ j p r
Click to summarize M_PROCESSOR_NUM

Inquires the number of processors (CPUs) available on the allocated Matrox imaging board.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
MIL system specific

Note that, when dealing with a Matrox Solios eCL/XCL with the optional Processing FPGA, the FPGA will register as a processor. To find out what type of Matrox Solios you are using, use M_BOARD_TYPE.

 ‡ l m
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize Value >= 0

Specifies the number of processors available.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_SERIAL_NUMBER

Inquires the serial number of the Matrox Imaging board, as a string.

(summarize)
‡ a b c e f g h i j k l m n p q r s t u
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm, Matrox 4Sight-X, and Matrox Supersight platforms]

M_SERIAL_NUMBER only applies to Matrox products. When a host system is allocated on a non-Matrox computer, no serial number is returned.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR (more details...)
 ‡ a b c e f g h i j k l m n p q r s t u
Click to summarize M_SERIAL_NUMBER_SIZE

Inquires the length of the string returned by M_SERIAL_NUMBER.

(summarize)
‡ a b c e f g h i j k l m n p q r s t u
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm, Matrox 4Sight-X, and Matrox Supersight platforms]

M_SERIAL_NUMBER only applies to Matrox products. When a host system is allocated on a non-Matrox computer, no serial number is returned.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b c e f g h i j k l m n p q r s t u
Click to summarize Value

Specifies the length of the string, including the terminating null character ("\0").

 ‡ a b c e f g h i j k l m n p q r s t u
Click to summarize M_SHARED_MEMORY_FREE

Inquires the total amount of free on-board shared memory.

(summarize)
‡ j k l m p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k l m p q r
Click to summarize Value

Specifies the total amount of free on-board shared memory, in bytes.

 ‡ j k l m p q r
Click to summarize M_SHARED_MEMORY_SIZE

Inquires the total amount of on-board shared memory.

(summarize)
‡ j k l m p q r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ j k l m p q r
Click to summarize Value

Specifies the total amount of on-board shared memory, in Mbytes.

 ‡ j k l m p q r
Click to summarize M_SYSTEM_DESCRIPTOR

Inquires the system descriptor. SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR (more details...)
 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_SYSTEM_1394

Specifies a MIL IEEE 1394b IIDC system.

 ‡ e
Click to summarize M_SYSTEM_CRONOSPLUS

Specifies a MIL CronosPlus system.

 ‡ b
Click to summarize M_SYSTEM_DEFAULT

Specifies the default system. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_SYSTEM_GIGE_VISION

Specifies a MIL GigE Vision system. INFO

 ‡ c s
Click to summarize M_SYSTEM_GPU

Specifies a MIL GPU system.

 ‡ d
Click to summarize M_SYSTEM_HOST

Specifies a Host system. INFO

 ‡ a f
Click to summarize M_SYSTEM_IRIS_GT

Specifies a MIL Iris GT system.

 ‡ f
Click to summarize M_SYSTEM_IRIS_GTR

Specifies a MIL Iris GTR system.

 ‡ t
Click to summarize M_SYSTEM_MORPHIS

Specifies a MIL Morphis system.

 ‡ g
Click to summarize M_SYSTEM_MORPHISQXT

Specifies a MIL Morphis QxT system.

 ‡ h
Click to summarize M_SYSTEM_ORION_HD

Specifies a MIL Orion HD system.

 ‡ i u
Click to summarize M_SYSTEM_RADIENT

Specifies a MIL Radient system.

 ‡ j
Click to summarize M_SYSTEM_RADIENTCLHS

Specifies a MIL Radient eV-CLHS system.

 ‡ q
Click to summarize M_SYSTEM_RADIENTCXP

Specifies a MIL Radient eV-CXP system.

 ‡ k
Click to summarize M_SYSTEM_RADIENTEVCL

Specifies a MIL Radient eV-CL system.

 ‡ r
Click to summarize M_SYSTEM_RADIENTPRO

Specifies a MIL Radient Pro Camera-Link system.

 ‡ p r
Click to summarize M_SYSTEM_SOLIOS

Specifies a MIL Solios system.

 ‡ l m
Click to summarize M_SYSTEM_USB3_VISION

Specifies a MIL USB3 Vision system. INFO

 ‡ o
Click to summarize M_SYSTEM_VIO

Specifies a MIL Vio system.

 ‡ n
Click to summarize MIL_TEXT("dmilpcie://[Passkey:]RemoteComputerName[:Port]/MILSystemType") 1
[This is only applicable to Matrox Supersight platform]

Specifies a DMIL remote system on a remote Matrox Supersight SHB that will communicate with the local SHB, using the PCIe protocol. INFO

 ‡ a b c d e g h i j l m n o p r s u
Click to summarize MIL_TEXT("dmilshm://[Passkey:]localhost[:Port]/MILSystemType") 1

Specifies a DMIL remote system for a separate process on the local computer, using the DMIL SHM protocol. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize MIL_TEXT("dmiltcp://[Passkey:]RemoteComputerName[:Port]/MILSystemType") 1

Specifies a DMIL remote system on a remote or local computer, using the TCP/IP protocol. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_SYSTEM_DESCRIPTOR_SIZE

Inquires the length of the string returned by M_SYSTEM_DESCRIPTOR.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize Value

Specifies the length of the string, including the terminating null character ("\0").

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_SYSTEM_TYPE

Inquires the type of system allocated. SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_SYSTEM_1394_TYPE

Specifies a MIL IEEE 1394 IIDC system.

 ‡ e
Click to summarize M_SYSTEM_CRONOSPLUS_TYPE

Specifies a MIL CronosPlus system.

 ‡ b
Click to summarize M_SYSTEM_GIGE_VISION_TYPE

Specifies a MIL GigE Vision system.

 ‡ c s
Click to summarize M_SYSTEM_GPU_TYPE

Specifies a MIL GPU system.

 ‡ d
Click to summarize M_SYSTEM_HOST_TYPE

Specifies the Host.

 ‡ a
Click to summarize M_SYSTEM_IRIS_GT_TYPE

Specifies a MIL Iris GT system.

 ‡ f
Click to summarize M_SYSTEM_IRIS_GTR_TYPE

Specifies a MIL Iris GTR system.

 ‡ t
Click to summarize M_SYSTEM_MORPHIS_TYPE

Specifies a MIL Morphis system.

 ‡ g
Click to summarize M_SYSTEM_MORPHISQXT_TYPE

Specifies a MIL Morphis QxT system.

 ‡ h
Click to summarize M_SYSTEM_ORION_HD_TYPE

Specifies a MIL Orion HD system.

 ‡ i u
Click to summarize M_SYSTEM_RADIENT_TYPE

Specifies a MIL Radient system.

 ‡ j
Click to summarize M_SYSTEM_RADIENTCLHS_TYPE

Specifies a MIL Radient eV-CLHS system.

 ‡ q
Click to summarize M_SYSTEM_RADIENTCXP_TYPE

Specifies a MIL Radient eV-CXP system.

 ‡ k
Click to summarize M_SYSTEM_RADIENTEVCL_TYPE

Specifies a MIL Radient eV-CL system.

 ‡ r
Click to summarize M_SYSTEM_RADIENTPRO_TYPE

Specifies a MIL Radient Pro system.

 ‡ p
Click to summarize M_SYSTEM_SOLIOS_TYPE

Specifies a MIL Solios system.

 ‡ l m
Click to summarize M_SYSTEM_USB3_VISION_TYPE

Specifies a MIL USB3 Vision system.

 ‡ o
Click to summarize M_SYSTEM_VIO_TYPE

Specifies a MIL Vio system.

 ‡ n
Click to summarize M_TEMPERATURE

Inquires the current temperature of the sensor.

(summarize)
‡ i t u
MIL system specific

On Matrox Clarity UHD, this value returns the temperature of the graphics controller.

 ‡ i u

On Matrox Iris GTR, this value returns the temperature of the daughter board (inbox).

 ‡ i t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ i t u
Click to summarize Value

Specifies the current temperature, in degrees Celsius.

 ‡ i t u
Click to summarize M_TEMPERATURE_CPU

Inquires the current temperature of the CPU.

(summarize)
‡ i t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ i t
Click to summarize Value

Specifies the current temperature, in degrees Celsius.

 ‡ i t
Click to summarize M_TEMPERATURE_FPGA

Inquires the current temperature of the grab firmware.

(summarize)
‡ j k p q r t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ j k p q r t
Click to summarize Value

Specifies the current temperature, in degrees Celsius.

 ‡ j k p q r t
Click to summarize M_TEMPERATURE_FPGA_MAX_MEASURED

Inquires the maximum temperature of the grab firmware measured.

(summarize)
‡ j t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ j t
Click to summarize Value

Specifies the maximum measured temperature, in degrees Celsius.

 ‡ j t
Click to summarize M_TEMPERATURE_FPGA_PROCESSING

Inquires the current temperature of the processing firmware.

(summarize)
‡ j
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ j
Click to summarize Value

Specifies the current temperature, in degrees Celsius.

 ‡ j
Click to summarize M_TEMPERATURE_FPGA_PROCESSING_MAX_MEASURED

Inquires the maximum temperature of the processing firmware measured.

(summarize)
‡ j
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ j
Click to summarize Value

Specifies the maximum measured temperature, in degrees Celsius.

 ‡ j
Click to summarize M_TEMPERATURE_IMAGE_SENSOR +

Inquires the current temperature of the image sensor.

(summarize)
‡ t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ t
Click to summarize Value

Specifies the current temperature, in degrees Celsius.

 ‡ t
Click to summarize M_THREAD_MODE

Inquires whether threads allocated on the system can execute in asynchronous mode. SET

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_ASYNCHRONOUS

Specifies that threads allocated on the system can execute in asynchronous mode. INFO

 ‡ b c d e g h i j k l m n o p q r s u
Click to summarize M_SYNCHRONOUS

Specifies that threads allocated on the system can only execute in synchronous mode. INFO

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_TIMEOUT

Inquires the maximum amount of time for the Host to wait for a synchronous function to return before generating a time-out error, in secs. SET

(summarize)
‡ b c e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ b c e f g h i j k l m n o p q r s t u
Click to summarize M_INFINITE

Waits indefinitely.

 ‡ f l t
Click to summarize Value

Specifies the time to wait, in secs.

 ‡ b c e f g h i j k l m n o p q r s t u
Click to summarize M_UART_PRESENT

Inquires the number of UARTs on the system.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize Value

Specifies the number of UARTs on the system.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_WATCHDOG_PRESENT

Inquires whether Watchdog circuitry is present.

(summarize)
‡ a b c d e f g h i j k l m n o p q r s t u
Expand data type infoCollapse data type info UserVarPtr extra info
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
Click to summarize M_FALSE

Specifies that Watchdog circuitry is not present.

 ‡ a b c d e f g h i j k l m n o p q r s t u
Click to summarize M_TRUE

Specifies that Watchdog circuitry is present.

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

1 If the value was passed in a variable, it won't be returned enclosed in MIL_TEXT().

Combination value for M_MULTI_THREAD (when InquireType=M_MODIFIED_BUFFER_HOOK_MODE and UserVarPtr=M_MULTI_THREAD).

The following value might be combined with the above-mentioned value to determine the number of hook threads.

function map Returns the number of hook threads that were allocated
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize Value >= 1

Specifies the number of hook threads that were allocated . INFO

 ‡ c g h j k l m n o p q r s
Combination value for M_DIGITIZER_TYPE; M_TEMPERATURE_IMAGE_SENSOR.

You can add the following value to the above-mentioned values to specify the acquisition path to inquire.

function map For specifying the acquisition path to inquire
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_DEV0

Specifies the number of the acquisition path to inquire.

 ‡ f t

The following inquire types and inquire values allow you to inquire the number, mode, and the purpose of I/O signals (such as, auxiliary signal). Once the format, routing, and mode are determined for an I/O signal, you can further inquire the I/O signal using the inquire types described in the For inquiring the state of specified user-bits in a static-user-output register table.

Note that for other Matrox imaging boards that have auxiliary I/O signals, but are not supported with the constants below, see MdigInquire().

function map For inquiring I/O signals and their mode
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_AUX_IO_COUNT

Inquires the total number of auxiliary signals.

(summarize)
‡ a b e f g h n t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h n t
Click to summarize Value

Specifies the total number of auxiliary signals.

 ‡ a b e f g h n t
Click to summarize M_AUX_IO_COUNT_IN

Inquires the total number of auxiliary input and I/O signals.

(summarize)
‡ a b e f g h n t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h n t
Click to summarize Value

Specifies the total number of auxiliary input and I/O signals.

 ‡ a b e f g h n t
Click to summarize M_AUX_IO_COUNT_OUT

Inquires the total number of auxiliary output and I/O signals.

(summarize)
‡ a b e f g h n t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h n t
Click to summarize Value

Specifies the total number of auxiliary output and I/O signals.

 ‡ a b e f g h n t
Click to summarize M_IO_DEBOUNCE_TIME +

Inquires the amount of time that the specified auxiliary input signal is debounced. SET


You must specify a combination value from the following table:
(summarize)
‡ a f t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a f t
Click to summarize 250;1000;5000;10000;1000000;10000000;25000000

Specifies the amount of time that an auxiliary input signal must be active for it to be accepted, in nsecs.

 ‡ f
Click to summarize Value >= 0

Specifies the minimum amount of time to ignore any additional signal transitions after accepting a signal transition, in nsecs. INFO

 ‡ a t
Click to summarize M_IO_FORMAT +

Inquires the format for an I/O signal. For more information, refer to the Technical information appendix in the Installation and Hardware Reference manual for your Matrox imaging board.


You must specify a combination value from the following table:
(summarize)
‡ a f
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a f
Click to summarize M_CURRENT_SOURCE

Specifies that the specified I/O is an current-controlled output.

 ‡ a f
Click to summarize M_OPEN_DRAIN

Specifies that the specified I/O is an open collector (open drain) I/O signal.

 ‡ a f
Click to summarize M_OPTO

Specifies that the specified I/O is an opto-coupled I/O signal.

 ‡ a f
Click to summarize M_IO_GLITCH_FILTER_STATE +
[This is only applicable to Matrox 4Sight GP/GPm platform]

Inquires whether the glitch filter is enabled. SET


You must specify a combination value from the following table:
(summarize)
‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a
Click to summarize M_DISABLE

Specifies not to use a glitch filter.

 ‡ a
Click to summarize M_ENABLE

Specifies to use a glitch filter.

 ‡ a
Click to summarize M_IO_INTERRUPT_ACTIVATION +

Inquires the signal transition upon which to generate an interrupt, if interrupt generation has been enabled for the specified I/O signal. SET


You must specify a combination value from the following table:
(summarize)
‡ a b e f g h t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h t
Click to summarize M_ANY_EDGE

Specifies to generate an interrupt upon both a low-to-high and a high-to-low signal transition.

 ‡ b e g h
Click to summarize M_EDGE_FALLING

Specifies that an interrupt will be generated upon a high-to-low signal transition.

 ‡ a b e f g h t
Click to summarize M_EDGE_RISING

Specifies that an interrupt will be generated upon a low-to-high signal transition.

 ‡ a b e f g h t
Click to summarize M_IO_INTERRUPT_STATE +

Inquires whether to generate an interrupt upon the specified transition of the I/O signal. SET


You must specify a combination value from the following table:
(summarize)
‡ a b e f g h t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h t
Click to summarize M_DISABLE

Specifies not to generate an interrupt.

 ‡ a b e f g h t
Click to summarize M_ENABLE

Specifies to generate an interrupt.

 ‡ a b e f g h t
Click to summarize M_IO_INVERTER +

Inquires whether the output of the specified I/O signal should be inverted. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_DEFAULT

Same as M_DISABLE.

 ‡ a t
Click to summarize M_DISABLE

Specifies not to invert the specified I/O signal.

 ‡ a t
Click to summarize M_ENABLE

Specifies to invert the specified I/O signal.

 ‡ a t
Click to summarize M_IO_MODE +

Inquires mode of the specified I/O signal. SET


You must specify a combination value from the following table:
(summarize)
‡ b f g h t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ b f g h t
Click to summarize M_INPUT

Specifies that the signal is for input.

 ‡ b f g h t
Click to summarize M_OUTPUT

Specifies that the signal is for output.

 ‡ b f g h t
Click to summarize M_IO_SOURCE +

Inquires the type of signal to route to an output signal, or an I/O signal set to output mode. SET


You must specify a combination value from the following table:
(summarize)
‡ a f g h t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a f g h t
Click to summarize M_AUX_IOn

Specifies to route auxiliary signal n, where n is a number of the auxiliary signal.

 ‡ a f g h t
Click to summarize M_EXPOSURE

Specifies to route the exposure signal of the camera.

 ‡ f t
Click to summarize M_GRAB_TRIGGER

Specifies to route the grab trigger signal.

 ‡ f
Click to summarize M_GRAB_TRIGGER_READY

Specifies to route the internal grab trigger ready signal.

 ‡ t
Click to summarize M_IO_COMMAND_LISTn +

Specifies to route the output a bit of the I/O command register of I/O command list n, where n is the number of the I/O command list. INFO


This value is combined with a value from the following table:
(summarize)
‡ a t
Click to summarize M_ROTARY_ENCODERn

Specifies to route the output of rotary encoder n, where n is the number of rotary encoders available. INFO

 ‡ a f t
Click to summarize M_TIMER_STROBE

Specifies to route the internal timer strobe signal.

 ‡ t
Click to summarize M_TIMERn

Specifies to route the output of timer n, where n is the number of timers available. INFO

 ‡ a f t
Click to summarize M_USER_BITn

Specifies to route the state of bit n of the main static-user-output register, where n is the bit number. INFO

 ‡ a f t
Click to summarize M_IO_STATUS +

Inquires the status of the specified I/O signal.


You must specify a combination value from the following table:
(summarize)
‡ a b e f g h t
MIL system specific

Inquiring the status of signals dedicated for trigger inputs will generate an error.

 ‡ b f g t
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h t
Click to summarize M_INVALID

Specifies that the I/O signal is disabled.

 ‡ a b e g h
Click to summarize M_OFF

Specifies that the I/O signal is off.

 ‡ a b e f g h t
Click to summarize M_ON

Specifies that the I/O signal is on.

 ‡ a b e f g h t
Click to summarize M_UNKNOWN

Specifies that the I/O signal cannot be inquired with its current configuration.

 ‡ a b e f g h t
Click to summarize M_IO_STATUS_ALL +

Inquires the status of all available I/O signals. Note that if there are I/O signals that cannot be inquired, the bits representing those signals, in the bit-encoded value returned, are not necessarily valid; these bits should be ignored.

(summarize)
‡ a b e f g h t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
 ‡ a b e f g h t
Click to summarize Value

Specifies the bit-encoded value representing the status of all available and inquirable I/O signals.

(summarize)
‡ a b e f g h t
MIL system specific

The status of signals dedicated for trigger inputs are indeterminable. The bit(s) representing dedicated trigger signal(s) are to be ignored.

 ‡ b f g t
Combination value for M_IO_DEBOUNCE_TIME; M_IO_FORMAT; M_IO_GLITCH_FILTER_STATE; M_IO_INTERRUPT_ACTIVATION; M_IO_INTERRUPT_STATE; M_IO_INVERTER; M_IO_MODE; M_IO_SOURCE; M_IO_STATUS.

You must add the following value to the above-mentioned values to specify the type and number of the I/O signal .

function map For inquiring the type and number of the I/O signal
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_AUX_IOn

Specifies to affect auxiliary signal n, where n is the signal number. INFO

 ‡ a b e f g h t
Combination value for M_IO_STATUS_ALL.

You can add the following value to the above-mentioned value to specify the type of I/O signal to inquire.

function map For specifying the type of I/O signal to inquire
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_AUX_IO

Specifies to inquire all auxiliary signals.

 ‡ a b e f g h t

The following inquire types and inquire values specify the settings for specified bits in a static-user-output register. The user-bits are the bits associated with output signals or I/O signals set to output. To establish which user-bits can be routed to a specific signal, see the connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board.

Note that for other Matrox imaging boards that have user-bits, but are not supported with the constants below, see MdigInquire().

function map For inquiring the state of specified user-bits in a static-user-output register
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_USER_BIT_COUNT

Inquires the total number of bits of the main static-user-output register.

(summarize)
‡ a b e f g h n t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h n t
Click to summarize Value

Specifies the number of bits in the main static-user-output register.

 ‡ a b e f g h n t
Click to summarize M_USER_BIT_STATE +

Inquires the state of the specified bit in a static-user-output register. SET


You must specify a combination value from the following table:
(summarize)
‡ a b e f g h t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a b e f g h t
Click to summarize M_OFF

Specifies that the specified bit is set to off.

 ‡ a b e f g h t
Click to summarize M_ON

Specifies that the specified bit is set to on.

 ‡ a b e f g h t
Click to summarize M_USER_BIT_STATE_ALL

Inquires the state of all the bits in the main static-user-output register. SET

(summarize)
‡ a b e f g h t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a host system if the host system has been allocated on a Matrox 4Sight.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
 ‡ a b e f g h t
Click to summarize Value

Specifies a bit-encoded value that establishes the value of all the bits of the specified static-user-output register. INFO

 ‡ a b e f g h t
Combination value for M_USER_BIT_STATE.

You must add the following value to the above-mentioned value to specify the bit in the static-user-output register.

function map For inquiring the bit in the static-user-output register
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_USER_BITn

Specifies to affect bit n of the main static-user-output register.

 ‡ a b e f g h t

The following inquire types and inquire values allow you to inquire about timers and the signals generated from a timer (timer output signals). For more information, see the Timers and coordinating events section of Chapter 26: I/O signals and communicating with external devices.

function map For inquiring the settings of a timer
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_TIMER_ARM +

Inquires whether to enable the timer arming mechanism. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_DISABLE

Specifies that timer arming is disabled.

 ‡ a t
Click to summarize M_ENABLE

Specifies that timer arming is enabled.

 ‡ a t
Click to summarize M_TIMER_ARM_ACTIVATION +

Inquires the signal transition upon which to arm the timer. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_ANY_EDGE

Specifies that the timer will be armed by both a high-to-low and a low-to-high signal transition.

 ‡ a t
Click to summarize M_EDGE_FALLING

Specifies that the timer will be armed upon a high-to-low signal transition.

 ‡ a t
Click to summarize M_EDGE_RISING

Specifies that the timer will be armed upon a low-to-high signal transition.

 ‡ a t
Click to summarize M_LEVEL_HIGH

Specifies that a timer is continuously armed during a high signal polarity.

 ‡ a t
Click to summarize M_LEVEL_LOW

Specifies that a timer is continuously armed during a low signal polarity.

 ‡ a t
Click to summarize M_TIMER_ARM_SOURCE +

Inquires which input signal will arm the timer. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the source signal used to arm the specified timer, where n is the number of the auxiliary signal. INFO

 ‡ a t
Click to summarize M_EXPOSURE

Specifies to use the exposure signal as the trigger source.

 ‡ t
Click to summarize M_GRAB_TRIGGER_READY

Specifies to route the internal grab trigger ready signal to the specified signal.

 ‡ t
Click to summarize M_IO_COMMAND_LISTn +

Specifies to use a bit of the I/O command register of I/O command list n, where n is the number of the I/O command list. INFO


This value is combined with a value from the following table:
(summarize)
‡ a t
Click to summarize M_SOFTWARE

Specifies to use software to arm the specified timer.

 ‡ a t
Click to summarize M_TIMER_STROBE

Specifies to route the strobe's timer signal to the specified signal.

 ‡ t
Click to summarize M_TIMERn

Specifies to use the output signal of the specified timer as the source signal to arm the timer, where n is the timer number. INFO

 ‡ a t
Click to summarize M_TIMER_CLOCK_ACTIVATION +

Inquires the edge of the signal that will increment the clock used to control the active portion of the timer's output signal. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_ANY_EDGE

Specifies that the clock will be incremented by both a high-to-low and a low-to-high signal transition.

 ‡ a t
Click to summarize M_EDGE_FALLING

Specifies that the clock will be incremented by a high-to-low signal transition.

 ‡ a t
Click to summarize M_EDGE_RISING

Specifies that the clock will be incremented by a low-to-high signal transition.

 ‡ a t
Click to summarize M_TIMER_CLOCK_FREQUENCY +

Inquires the frequency of the clock source signal for the active portion of the timer's output signal (M_TIMER_CLOCK_SOURCE). SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ a t
Click to summarize M_UNKNOWN

Specifies that the signal is not periodic or the frequency is unknown.

 ‡ a t
Click to summarize 0 < Value <= Frequency of M_SYSCLK

Specifies the frequency, in Hz.

 ‡ a t
Click to summarize M_TIMER_CLOCK_SOURCE +

Inquires the source of the clock that drives the active portion of the specified timer's output signal. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the clock source, where n is the number of the auxiliary signal. INFO

 ‡ a t
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n as the clock source, where n is the number of the rotary decoder. INFO

 ‡ a t
Click to summarize M_SYSCLK

Specifies to use the allocated system's clock source.

 ‡ a t
Click to summarize M_TIMER_DELAY +

Inquires the delay between the timer trigger and the active portion of the timer's output signal.

Note, an error is generated if the specified delay cannot be respected. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ a t
Click to summarize 0 <= Value <= Max. value

Specifies the delay. INFO

 ‡ a t
Click to summarize M_TIMER_DELAY_CLOCK_ACTIVATION +

Inquires the signal transition that will increment the clock used to control the delay between the timer's trigger and the active portion of the timer's output signal. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_ANY_EDGE

Specifies that the clock will be incremented by both a high-to-low and a low-to-high signal transition.

 ‡ a t
Click to summarize M_EDGE_FALLING

Specifies that the clock will be incremented by a high-to-low signal transition.

 ‡ a t
Click to summarize M_EDGE_RISING

Specifies that the clock will be incremented by a low-to-high signal transition.

 ‡ a t
Click to summarize M_TIMER_DELAY_CLOCK_FREQUENCY +

Inquires the frequency of the clock source signal for the delay between the timer's trigger and the active portion of the timer's output signal (M_TIMER_DELAY_CLOCK_SOURCE). SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ a t
Click to summarize M_UNKNOWN

Specifies that the signal is not periodic or the frequency is unknown.

 ‡ a t
Click to summarize 0 < Value <= Frequency of M_SYSCLK

Specifies the frequency, in Hz.

 ‡ a t
Click to summarize M_TIMER_DELAY_CLOCK_SOURCE +

Inquires the source of the clock that drives the delay between the timer's trigger and the active portion of the specified timer's output signal. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the clock source, where n is the number of the auxiliary signal. INFO

 ‡ a t
Click to summarize M_FOLLOW_TIMER_CLOCK

Specifies to use the clock source specified by M_TIMER_CLOCK_SOURCE. INFO

 ‡ a t
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n as the clock source, where n is the number of the rotary decoder. INFO

 ‡ a t
Click to summarize M_SYSCLK

Specifies to use the allocated system's clock source.

 ‡ a t
Click to summarize M_TIMER_DURATION +

Inquires the duration for the active portion of the timer's output signal.

Note, an error is generated if the specified duration cannot be respected. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ a t
Click to summarize 0 <= Value <= Max. value

Specifies the duration of the active portion of the timer output signal. INFO

 ‡ a t
Click to summarize M_TIMER_OUTPUT_INVERTER +

Inquires whether the output of the timer should be inverted. This causes the low portion of the signal (the delay period) to be high and the high portion of the signal (the active portion) to be low. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_DISABLE

Specifies not to invert the output of the timer.

 ‡ a t
Click to summarize M_ENABLE

Specifies to invert the output of the timer.

 ‡ a t
Click to summarize M_TIMER_STATE +

Inquires the state of the specified timer. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_DISABLE

Specifies that the timer is disabled.

 ‡ a t
Click to summarize M_ENABLE

Specifies that the timer is enabled.

 ‡ a t
Click to summarize M_TIMER_TRIGGER_ACTIVATION +

Inquires the signal variation upon which to generate a timer trigger, if the specified timer is enabled. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_ANY_EDGE

Specifies that a timer trigger will be generated both upon a high-to-low and a low-to-high signal transition.

 ‡ a t
Click to summarize M_EDGE_FALLING

Specifies that a timer trigger will be generated upon a high-to-low signal transition.

 ‡ a t
Click to summarize M_EDGE_RISING

Specifies that a timer trigger will be generated upon a low-to-high signal transition.

 ‡ a t
Click to summarize M_LEVEL_HIGH

Specifies that a timer trigger is continuously issued during a high signal polarity.

 ‡ a t
Click to summarize M_LEVEL_LOW

Specifies that a timer trigger is continuously issued during a low signal polarity.

 ‡ a t
Click to summarize M_TIMER_TRIGGER_OVERLAP +

Inquires how to deal with a new trigger that occurs while the previously triggered timer (both its delay and duration) has not expired. SET


You must specify a combination value from the following table:
(summarize)
‡ t
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ t
Click to summarize M_DEFAULT

Same as M_OFF.

 ‡ t
Click to summarize M_LATCH

Specifies that a trigger received, while the associated timer has not expired, will be latched (stored). INFO

 ‡ t
Click to summarize M_OFF

Specifies that a new trigger is ignored.

 ‡ t
Click to summarize M_RESET

Specifies that a new trigger automatically resets the timer (regardless of whether it is in its delay or active period) and then restarts the timer. INFO

 ‡ t
Click to summarize M_TIMER_TRIGGER_SOURCE +

Inquires the trigger source for the specified timer. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the trigger source for the specified timer, where n is the number of the auxiliary signal. INFO

 ‡ a t
Click to summarize M_CONTINUOUS

Specifies to run the specified timer in periodic mode; no actual trigger signal is used. INFO

 ‡ a t
Click to summarize M_EXPOSURE

Specifies to use the exposure signal as the trigger source.

 ‡ t
Click to summarize M_GRAB_TRIGGER_READY

Specifies to route the internal grab trigger ready signal to the specified signal.

 ‡ t
Click to summarize M_IO_COMMAND_LISTn +

Specifies to use a bit of the I/O command register of I/O command list n, where n is the number of the I/O command list. INFO


This value is combined with a value from the following table:
(summarize)
‡ a t
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n as the trigger source, where n is the number of the rotary decoder. INFO

 ‡ a t
Click to summarize M_SOFTWARE

Specifies to use a software trigger as the trigger source. INFO

 ‡ a t
Click to summarize M_TIMER_STROBE

Specifies to route the strobe's timer signal to the specified signal.

 ‡ t
Click to summarize M_TIMERn

Specifies to use the output signal of the specified timer as the trigger source, where n is the timer number. INFO

 ‡ a t
Click to summarize M_TIMER_USAGE +

Inquires how the timer should be used. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_PULSE_GENERATION

Specifies the normal use of the timer, as described in the Timers and coordinating events section of Chapter 26: I/O signals and communicating with external devices.

 ‡ a t
Click to summarize M_PULSE_MEASUREMENT

Specifies to use the timer to measure the duration of the pulse that occurs on the timer's trigger source. INFO

 ‡ a t
Click to summarize M_TIMER_VALUE +

Inquires the current value of the timer's duration.


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
 ‡ a t
Click to summarize Value >= 0

Specifies current value of the timer's duration. If M_TIMER_DELAY_CLOCK_SOURCE is set to M_SYSCLK or a frequency is specified using M_TIMER_DELAY_CLOCK_FREQUENCY, this value is specified in nsecs. Otherwise, it is specified in number of signal transitions on the source signal.

(summarize)
‡ a t
Combination value for the values listed in For inquiring the settings of a timer.

You must add the following value to the above-mentioned values to specify which on-board timer to inquire.

function map For specifying which on-board timer to inquire
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_TIMERn

Specifies on-board timer n, where n is the number of the timer. INFO

 ‡ a t
Combination value for M_IO_COMMAND_LISTn (when InquireType=M_IO_SOURCE and UserVarPtr=M_IO_COMMAND_LISTn); M_IO_COMMAND_LISTn (when InquireType=M_TIMER_ARM_SOURCE and UserVarPtr=M_IO_COMMAND_LISTn); M_IO_COMMAND_LISTn (when InquireType=M_TIMER_TRIGGER_SOURCE and UserVarPtr=M_IO_COMMAND_LISTn).

The following value is combined with the above-mentioned values to specify which I/O command register bit was used.

function map For specifying which I/O command register bit was used
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_IO_COMMAND_BITn

Specifies I/O command register bit n, where n represents the bit number. INFO

 ‡ a t
Combination values for M_TIMER_DELAY; M_TIMER_DURATION.

You can add one of the following values to the above-mentioned values to determine the maximum or minimum value for the setting.

function map For inquiring the maximum or minimum value for the setting
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_MAX_VALUE
[This is only applicable to Matrox 4Sight GP/GPm platform]

Specifies the maximum value for this setting.

 ‡ a
Click to summarize M_MIN_VALUE
[This is only applicable to Matrox 4Sight GP/GPm platform]

Specifies the minimum value for this setting.

 ‡ a

The following inquire types and inquire values allow you to inquire about the settings of a rotary decoder.

function map For inquiring the settings of a rotary decoder
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_ROTARY_ENCODER_BIT0_SOURCE +

Inquires the auxiliary input signal on which to receive bit 0 of the 2-bit Gray code. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the signal on which to receive bit 0 of the 2-bit Gray code, where n is the number of the auxiliary signal. INFO

 ‡ a t
Click to summarize M_ROTARY_ENCODER_BIT1_SOURCE +

Inquires the auxiliary input signal on which to receive bit 1 of the 2-bit Gray code. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the signal on which to receive bit 1 of the 2-bit Gray code, where n is the number of the auxiliary signal. INFO

 ‡ a t
Click to summarize M_ROTARY_ENCODER_OUTPUT_MODE +

Inquires the rotary decoder's counter value and/or the direction of movement upon which the rotary decoder should output a pulse. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_POSITION_TRIGGER

Specifies to output a pulse upon the trigger generated by M_ROTARY_ENCODER_POSITION_TRIGGER.

 ‡ a t
Click to summarize M_STEP_ANY

Specifies to output a pulse upon any change in the rotary decoder's counter value (position change in any direction).

 ‡ a t
Click to summarize M_STEP_BACKWARD

Specifies to output a pulse upon a rotary decoder counter decrement only.

 ‡ a t
Click to summarize M_STEP_FORWARD

Specifies to output a pulse upon a rotary decoder counter increment only.

 ‡ a t
Click to summarize M_STEP_FORWARD_NEW_POSITIVE

Specifies to output a pulse upon a rotary decoder counter increment of a new value that has not been reached before. INFO

 ‡ a t
Click to summarize M_ROTARY_ENCODER_POSITION_TRIGGER +

Inquires the value of the rotary decoder's counter upon which a trigger is generated. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize 0 <= Value <= 0xFFFFFFFF

Specifies the value of the counter upon which a trigger is generated. INFO

 ‡ a t
Click to summarize M_ROTARY_ENCODER_RESET_ACTIVATION +

Sets the signal transition upon which to reset the rotary decoder's coutner to 0. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_EDGE_FALLING

Specifies to reset the rotary decoder upon a high-to-low signal transition.

 ‡ a t
Click to summarize M_EDGE_RISING

Specifies to reset the rotary decoder upon a low-to-high signal transition.

 ‡ a t
Click to summarize M_ROTARY_ENCODER_RESET_SOURCE +

Inquires the signal source to use to reset the rotary decoder's counter to 0. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_NULL

Specifies not to reset using a hardware signal source.

 ‡ a t
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the trigger source for the specified timer, where n is the number of the auxiliary signal. INFO

 ‡ a t
Click to summarize M_POSITION_TRIGGER

Specifies to use the trigger signal generated by the rotary decoder when the counter reaches the value specified with M_ROTARY_ENCODER_POSITION_TRIGGER.

 ‡ a t
Click to summarize M_ROTARY_ENCODER_STATE +

Inquires whether the specified rotary decoder is enabled. SET


You must specify a combination value from the following table:
(summarize)
‡ a t
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm with MIL 10 Update 26 installed.

 ‡ a
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ a t
Click to summarize M_DISABLE

Specifies that the rotary decoder is disabled.

 ‡ a t
Click to summarize M_ENABLE

Specifies that the rotary decoder is enabled.

 ‡ a t
Combination value for the values listed in For inquiring the settings of a rotary decoder.

You must add the following value to the above-mentioned values to specify which rotary decoder to inquire.

function map For specifying which rotary decoder to inquire about
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_ROTARY_ENCODERn

Specifies rotary decoder n, where n is the number of the rotary decoder. INFO

 ‡ a t

The following inquire types allow you to inquire UART settings.

function map For UART settings
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_COM_PORT_NUMBER +

Inquires the Microsoft Windows COM port number associated with the specified UART. Note that the number of UARTs available differs, depending on the version of your board.

You must specify which COM port to inquire. See below for combination values.

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize Value

Specifies the Microsoft Windows COM port number associated with the specified UART.

 ‡ g j l m p r
Click to summarize M_UART_BYTES_READ +

Inquires the number of bytes read from the UART, after waiting for the UART read operation (using MsysControl() with M_UART_READ_STRING) to complete.

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize Value

Specifies the number of bytes read from the UART.

 ‡ g j l m p r
Click to summarize M_UART_BYTES_WRITTEN +

Inquires the number of bytes written to the UART, after waiting for the UART write operation (using MsysControl() with M_UART_WRITE_STRING) to complete.

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize Value

Specifies the number of bytes written to the UART, in bytes.

 ‡ g j l m p r
Click to summarize M_UART_DATA_PENDING +

Inquires whether the UART input buffer has pending data or not.

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize M_FALSE

Specifies that the UART input buffer does not have pending data.

 ‡ g j l m p r
Click to summarize M_TRUE

Specifies that the UART input buffer has pending data.

 ‡ g j l m p r
Click to summarize M_UART_DATA_SIZE +

Inquires the number of data bits per character that is sent or received by the UART. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize 7

Specifies that the data length is 7 bits.

 ‡ g j l m p r
Click to summarize 8

Specifies that the data length is 8 bits.

 ‡ g j l m p r
Click to summarize M_UART_INTERFACE_TYPE +

Inquires the type of interface used by the UART.

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize M_RS232

Specifies that an RS-232 interface is used.

 ‡ g j l m p r
Click to summarize M_RS485

Specifies that an RS-485 interface is used.

 ‡ g j l m p r
Click to summarize M_UART_PARITY +

Inquires whether character data is sent or recieved with a parity bit and how the parity bit is set. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize M_DISABLE

Species that no extra bit is added (no parity).

 ‡ g j l m p r
Click to summarize M_EVEN

Specifies that the number of 1's will be even.

 ‡ g j l m p r
Click to summarize M_ODD

Specifies that the number of 1's will be odd.

 ‡ g j l m p r
Click to summarize M_UART_READ_STRING_MAXIMUM_SIZE +

Inquires the maximum length of the string to be read using M_UART_READ_STRING. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize Value

Specifies the maximum length of the string, in bytes.

 ‡ g j l m p r
Click to summarize M_UART_READ_STRING_SIZE +

Inquires the number of bytes to read when calling MsysControl() with M_UART_READ_STRING. If this length is specified by M_UART_STRING_DELIMITER, the returned result will be M_DEFAULT. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize M_DEFAULT

Specifies the use of M_UART_STRING_DELIMITER to delineate the end of the string to read.

 ‡ g j l m p r
Click to summarize Value

Specifies the string length, in bytes.

 ‡ g j l m p r
Click to summarize M_UART_SPEED +

Inquires the baud rate of the UART. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize 300;600;1200;1800;2400;4800;7200;9600;14400;
19200;38400;57600;115200

Specifies the baud rate of the UART. INFO

 ‡ g j l m p r
Click to summarize M_UART_STOP_BITS +

Inquires the number of extra data bit(s) that are added to each character to indicate the end of a character. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize 1

Specifies that there is 1 stop bit.

 ‡ g j l m p r
Click to summarize 2

Specifies that there are 2 stop bits.

 ‡ g j l m p r
Click to summarize M_UART_STRING_DELIMITER +

Inquires the character used to terminate strings of incoming or outgoing data. The delimiter is used but not sent when writing data with M_UART_WRITE_STRING; it is read for incoming data with M_UART_READ_STRING. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize Value

Specifies the character used to terminate strings.

 ‡ g j l m p r
Click to summarize M_UART_TIMEOUT +

Inquires the maximum time to wait between each byte when reading incoming data. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize M_INFINITE

Waits indefinitely.

 ‡ g j l m p r
Click to summarize Value

Specifies the time to wait, in msecs.

 ‡ g j l m p r
Click to summarize M_UART_WRITE_STRING_SIZE +

Inquires the length of the string to be sent to the UART for transmission. SET

(summarize)
‡ g j l m p r
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g j l m p r
Click to summarize Value

Specifies the string length, in bytes.

 ‡ g j l m p r
Combination value for M_COM_PORT_NUMBER; M_UART_BYTES_READ; M_UART_BYTES_WRITTEN; M_UART_DATA_PENDING; M_UART_DATA_SIZE; M_UART_INTERFACE_TYPE; M_UART_PARITY; M_UART_READ_STRING_MAXIMUM_SIZE; M_UART_READ_STRING_SIZE; M_UART_SPEED; M_UART_STOP_BITS; M_UART_STRING_DELIMITER; M_UART_TIMEOUT; M_UART_WRITE_STRING_SIZE.

You can add the following value to the above-mentioned values to set which UART to inquire.

function map For COM Ports and UARTs
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize

Specifies which UART should be inquired.

(summarize)
‡ g j l m p r
Parameters

Specifies a device (UART) to inquire.

 ‡ g j l m p r
M_DEVn

Specifies the device to inquire, where n can be from 0 to 15.
‡ g j l m p r
MIL system specific

There is 1 UART available on Matrox Morphis.

 ‡ g

There are 4 UARTs available on Matrox Solios eA/XA Quad, 2 on Matrox Solios eA/XA Dual, and 1 on Matrox Solios eA/XA Single.

 ‡ l

There are 2 UARTs are available on Matrox Solios eCL/XCL dual-Base/single-Medium operating in dual-Base mode, and 1 is available on Matrox Solios eCL/XCL-B, eCL/XCL-F, and eCL/XCL dual-Base/single-Medium operating in single-Medium mode.

 ‡ j m p r

There are 2 UARTS available on Matrox Radient eCL-DB and eCL-DF, 4 on Matrox Radient eCL-QB, and 1 on Matrox Radient eCL-SF. Note that, using the CLProtocol will occupy one COM port per allocated digitizer.

 ‡ j p r

The following inquire types and inquire values specify the settings for the Watchdog.

function map For Watchdog settings
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_WATCHDOG_MODE

Inquires the current state of the Watchdog. SET

(summarize)
‡ g h
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h
Click to summarize M_DISABLE

Specifies that the Watchdog is disabled.

 ‡ g h
Click to summarize M_ENABLE

Specifies that the Watchdog is enabled.

 ‡ g h
Click to summarize M_WATCHDOG_REBOOT_TIMEOUT

Inquires the timeout value of the Watchdog's reboot timer. SET

(summarize)
‡ g h
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h
Click to summarize Value

Specifies the timeout value, in msecs.

 ‡ g h
Click to summarize M_WATCHDOG_RESET_COUNTER

Inquires the number of times the Watchdog has rebooted your computer.

(summarize)
‡ g h
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h
Click to summarize Value

Specifies the number of Watchdog reboots.

 ‡ g h
Click to summarize M_WATCHDOG_TIMEOUT

Inquires the timeout value of the Watchdog's main timer. SET

(summarize)
‡ g h
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h
Click to summarize Value

Specifies the timeout value, in msecs.

 ‡ g h
Click to summarize M_WATCHDOG_WARNING_TIME

Inquires the timeout value of the Watchdog's warning timer. SET

(summarize)
‡ g h
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ g h
Click to summarize M_INFINITE

Specifies that the Watchdog will never receive a warning.

 ‡ g h
Click to summarize Value

Specifies the warning time interval, in msecs.

 ‡ g h

The following inquire types and inquire values allow you to inquire the details of an action command. Action commands require both a MIL-side and a camera-side configuration. The following inquire types and inquire values inquire the MIL-side of the action command. To inquire the camera-side, use MdigInquireFeature() with the appropriate feature values. For more information, refer to the Triggering simultaneous actions in multiple GigE Vision cameras section of Chapter 4: Matrox GigE Vision driver.

function map For inquiring action commands
Click to summarize
InquireType		 Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_GC_ACTION_ACKNOWLEDGE_NUMBER +

Inquires the number of acknowledgments that MIL should expect to receive when the action command is issued. SET


You must specify a combination value from the following table:
(summarize)
‡ s
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ s
Click to summarize Value

Specifies the number of acknowledgments expected.

 ‡ s
Click to summarize M_GC_ACTION_DEVICE_KEY +

Inquires the action device key for the action command. The action device key identifies the cameras on which the action should be performed. SET


You must specify a combination value from the following table:
(summarize)
‡ s
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ s
Click to summarize Value

Specifies the action device key.

 ‡ s
Click to summarize M_GC_ACTION_GROUP_KEY +

Inquires the action group key for the action command. The action group key identifies which action command to perform on the camera. SET


You must specify a combination value from the following table:
(summarize)
‡ s
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ s
Click to summarize Value

Specifies the action group key.

 ‡ s
Click to summarize M_GC_ACTION_GROUP_MASK +

Inquires the action group mask for the action command. In the case where you need one (or more) cameras to temporarily ignore an action command, you can mask out the action command by changing the action group mask. SET


You must specify a combination value from the following table:
(summarize)
‡ s
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ s
Click to summarize Value

Specifies the action group mask.

 ‡ s
Click to summarize M_GC_ACTION_TIME +

Inquires the time at which the action command should execute. SET


You must specify a combination value from the following table:
(summarize)
‡ s
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
 ‡ s
Click to summarize Value

Specifies the time at which to execute the action command on your camera, relative to the time at which the action command was sent, in secs.

 ‡ s
Combination value for the values listed in For inquiring action commands.

You must add the following value to the above-mentioned values to set which action command to control.

function map For specifying which action command to control
Click to summarize
Combination value		 Description MIL system-specific
tooltip (‡)
Click to summarize M_GC_ACTIONn

Specifies to control action command n, where n is a value from 0 to 31.

 ‡ s
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.
Remark
Example

The following example uses M_BOARD_TYPE. The returned value is then masked so that only the board type is returned.

/* To return only the main board type, and not the sub-board types (for example M_XCL, 
M_FAST, or M_SDI), mask the return value with M_BOARD_TYPE_MASK.
*/

/* Call MsysInquire with M_BOARD_TYPE  to inquire the full board type. */
MsysInquire(MilSystem, M_BOARD_TYPE, &BoardType);
 
/* Use M_BOARD_TYPE_MASK to verify the main board type. */
if ((BoardType & M_BOARD_TYPE_MASK) == M_SOLIOS)
{
/* Perform a Matrox Solios-specific task. */
}
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
DEFAULT HOST ACCELERATOR PRESENT NO YES ALLOCATION OVERSCAN DISABLE ENABLE ALLOCATION OVERSCAN SIZE ASYNCHRONOUS CALL SUPPORT NO YES BOARD REVISION BOARD SUB REVISION BOARD TYPE CLARITY UHD CRONOSPLUS GIGE VISION GPU HOST HOST M 4SIGHT M 4SIGHT GP HOST M 4SIGHT M 4SIGHT GPM HOST M 4SIGHT M 4SIGHT X HOST M SUPERSIGHT IEEE 1394 IIDC IEEE 1394 IIDC M CONCORD IRIS GT M GT300 IRIS GTR IRIS M GT1200 IRIS M GT1900 MORPHIS M 2VD M IO MORPHISQXT M 4VD M IO MORPHISQXT M 16VD M IO ORION HD RADIENT M CL M DBCL RADIENT M CL M DBCL M PF RADIENT M CL M DFCL RADIENT M CL M DFCL M PF RADIENT M CL M QBCL RADIENT M CL M QBCL M PF RADIENT M CL M SFCL RADIENT M CL M SFCL M PF RADIENT M CLHS M SC7MS3 RADIENT M CXP M D3G RADIENT M CXP M D6G RADIENT M CXP M Q3G RADIENT M CXP M Q6G RADIENTPRO M CL M DBCL M PF RADIENTPRO M CL M SFCL M PF SOLIOS M XA M DA SOLIOS M XA M QA SOLIOS M XA M SA SOLIOS M XCL M DBCL SOLIOS M XCL M DBCL M FAST SOLIOS M XCL M DBCL M PF SOLIOS M XCL M SBCL SOLIOS M XCL M SBCL M FAST SOLIOS M XCL M SBCL M PF SOLIOS M XCL M SFCL SOLIOS M XCL M SFCL M FAST SOLIOS M XCL M SFCL M PF SOLIOS M XCL M SMCL SOLIOS M XCL M SMCL M FAST SOLIOS M XCL M SMCL M PF USB3 VISION VIO M SA VIO M SA M DVI VIO M SA M SDI CURRENT THREAD ID DCF SUPPORTED FALSE TRUE DEFAULT PITCH BYTE MULTIPLE DIGITIZER NUM DIGITIZER TYPE 300 300C 1300 1300C 2000 2000C 5000 5000C GT300 GT1200 GT1900 DISPLAY OUTPUT NUM EXTENDED INIT FLAG DEFAULT COMPLETE PARTIAL FIRMWARE BUILDDATE FIRMWARE BUILDDATE PROCESSING FIRMWARE REVISION FIRMWARE REVISION PROCESSING GC FEATURE EXECUTE POLLING MODE AUTOMATIC MANUAL GENICAM AVAILABLE FALSE TRUE GRAB FPGA FAN RPM LED USER GREEN OFF ORANGE RED LOCATION LOCAL REMOTE MEMORY FREE MEMORY FREE BANK 0 MEMORY FREE BANK 1 MEMORY FREE BANK 2 MEMORY SIZE MEMORY SIZE BANK 0 MEMORY SIZE BANK 1 MEMORY SIZE BANK 2 MODIFIED BUFFER HOOK MODE MULTI THREAD SINGLE THREAD NUM CAMERA PRESENT NUMBER DEVn OWNER APPLICATION PCIE NUMBER OF LANES PCIE NUMBER OF LANES MAX PCIE SPEED GENn INVALID PCIE SPEED MAX GENn INVALID PROCESSING FPGA FAN RPM PROCESSOR NUM SERIAL NUMBER SERIAL NUMBER SIZE SHARED MEMORY FREE SHARED MEMORY SIZE SYSTEM DESCRIPTOR SYSTEM 1394 SYSTEM CLARITY UHD SYSTEM CRONOSPLUS SYSTEM DEFAULT SYSTEM GIGE VISION SYSTEM GPU SYSTEM HOST SYSTEM IRIS GT SYSTEM IRIS GTR SYSTEM MORPHIS SYSTEM MORPHISQXT SYSTEM ORION HD SYSTEM RADIENT SYSTEM RADIENTCLHS SYSTEM RADIENTCXP SYSTEM RADIENTEVCL SYSTEM RADIENTPRO SYSTEM SOLIOS SYSTEM USB3 VISION SYSTEM VIO SYSTEM DESCRIPTOR SIZE SYSTEM TYPE SYSTEM 1394 TYPE SYSTEM CLARITY UHD TYPE SYSTEM CRONOSPLUS TYPE SYSTEM GIGE VISION TYPE SYSTEM GPU TYPE SYSTEM HOST TYPE SYSTEM IRIS GT TYPE SYSTEM IRIS GTR TYPE SYSTEM MORPHIS TYPE SYSTEM MORPHISQXT TYPE SYSTEM ORION HD TYPE SYSTEM RADIENT TYPE SYSTEM RADIENTCLHS TYPE SYSTEM RADIENTCXP TYPE SYSTEM RADIENTEVCL TYPE SYSTEM RADIENTPRO TYPE SYSTEM SOLIOS TYPE SYSTEM USB3 VISION TYPE SYSTEM VIO TYPE TEMPERATURE TEMPERATURE CPU TEMPERATURE FPGA TEMPERATURE FPGA MAX MEASURED TEMPERATURE FPGA PROCESSING TEMPERATURE FPGA PROCESSING MAX MEASURED TEMPERATURE IMAGE SENSOR THREAD MODE ASYNCHRONOUS SYNCHRONOUS TIMEOUT INFINITE UART PRESENT WATCHDOG PRESENT FALSE TRUE DEV0 AUX IO COUNT AUX IO COUNT IN AUX IO COUNT OUT IO DEBOUNCE TIME IO FORMAT CURRENT SOURCE OPEN DRAIN OPTO IO GLITCH FILTER STATE DISABLE ENABLE IO INTERRUPT ACTIVATION ANY EDGE EDGE FALLING EDGE RISING IO INTERRUPT STATE DISABLE ENABLE IO INVERTER DEFAULT DISABLE ENABLE IO MODE INPUT OUTPUT IO SOURCE AUX IOn EXPOSURE GRAB TRIGGER GRAB TRIGGER READY IO COMMAND LISTn ROTARY ENCODERn TIMER STROBE TIMERn USER BITn IO STATUS INVALID OFF ON UNKNOWN IO STATUS ALL AUX IOn AUX IO USER BIT COUNT USER BIT STATE OFF ON USER BIT STATE ALL USER BITn TIMER ARM DISABLE ENABLE TIMER ARM ACTIVATION ANY EDGE EDGE FALLING EDGE RISING LEVEL HIGH LEVEL LOW TIMER ARM SOURCE AUX IOn EXPOSURE GRAB TRIGGER READY IO COMMAND LISTn SOFTWARE TIMER STROBE TIMERn TIMER CLOCK ACTIVATION ANY EDGE EDGE FALLING EDGE RISING TIMER CLOCK FREQUENCY UNKNOWN SYSCLK TIMER CLOCK SOURCE AUX IOn ROTARY ENCODERn SYSCLK TIMER DELAY TIMER DELAY CLOCK ACTIVATION ANY EDGE EDGE FALLING EDGE RISING TIMER DELAY CLOCK FREQUENCY UNKNOWN SYSCLK TIMER DELAY CLOCK SOURCE AUX IOn FOLLOW TIMER CLOCK ROTARY ENCODERn SYSCLK TIMER DURATION TIMER OUTPUT INVERTER DISABLE ENABLE TIMER STATE DISABLE ENABLE TIMER TRIGGER ACTIVATION ANY EDGE EDGE FALLING EDGE RISING LEVEL HIGH LEVEL LOW TIMER TRIGGER OVERLAP DEFAULT LATCH OFF RESET TIMER TRIGGER SOURCE AUX IOn CONTINUOUS EXPOSURE GRAB TRIGGER READY IO COMMAND LISTn ROTARY ENCODERn SOFTWARE TIMER STROBE TIMERn TIMER USAGE PULSE GENERATION PULSE MEASUREMENT TIMER VALUE TIMERn IO COMMAND BITn MAX VALUE MIN VALUE ROTARY ENCODER BIT0 SOURCE AUX IOn ROTARY ENCODER BIT1 SOURCE AUX IOn ROTARY ENCODER OUTPUT MODE POSITION TRIGGER STEP ANY STEP BACKWARD STEP FORWARD STEP FORWARD NEW POSITIVE ROTARY ENCODER POSITION TRIGGER ROTARY ENCODER RESET ACTIVATION EDGE FALLING EDGE RISING ROTARY ENCODER RESET SOURCE NULL AUX IOn POSITION TRIGGER ROTARY ENCODER STATE DISABLE ENABLE ROTARY ENCODERn COM PORT NUMBER UART BYTES READ UART BYTES WRITTEN UART DATA PENDING FALSE TRUE UART DATA SIZE UART INTERFACE TYPE RS232 RS485 UART PARITY DISABLE EVEN ODD UART READ STRING MAXIMUM SIZE UART READ STRING SIZE DEFAULT UART SPEED UART STOP BITS UART STRING DELIMITER UART TIMEOUT INFINITE UART WRITE STRING SIZE DEVn WATCHDOG MODE DISABLE ENABLE WATCHDOG REBOOT TIMEOUT WATCHDOG RESET COUNTER WATCHDOG TIMEOUT WATCHDOG WARNING TIME INFINITE GC ACTION ACKNOWLEDGE NUMBER GC ACTION DEVICE KEY GC ACTION GROUP KEY GC ACTION GROUP MASK GC ACTION TIME GC ACTIONn M_DEVn M_GENn M_GENn M_AUX_IOn M_IO_COMMAND_LISTn M_ROTARY_ENCODERn M_TIMERn M_USER_BITn M_AUX_IOn M_USER_BITn M_AUX_IOn M_IO_COMMAND_LISTn M_TIMERn M_AUX_IOn M_ROTARY_ENCODERn M_AUX_IOn M_ROTARY_ENCODERn M_AUX_IOn M_IO_COMMAND_LISTn M_ROTARY_ENCODERn M_TIMERn M_TIMERn M_IO_COMMAND_BITn M_AUX_IOn M_AUX_IOn M_AUX_IOn M_ROTARY_ENCODERn M_DEVn M_GC_ACTIONn