| MIL 10 Reference
| Customize Help
| Save Settings

MsysIoInquire


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Not supported on:
Not supported on Matrox CronosPlus
Not supported on Matrox GPU processing driver
Not supported on Matrox GigE Vision driver
Not supported on Matrox IEEE 1394 IIDC driver
Not supported on Matrox Iris GT
Not supported on Matrox Morphis
Not supported on Matrox Morphis QxT
Not supported on Matrox Orion HD
Not supported on Matrox Radient eCL
Not supported on Matrox Radient eV-CXP
Not supported on Matrox Solios eA/XA
Not supported on Matrox Solios ecl/xcl/ev-cl
Not supported on Matrox USB3 Vision driver (requires Update 19)
Not supported on Matrox Vio
Fully supported on:
Fully supported on Host system

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Not available on Matrox 4Sight-X
Not available on Matrox Supersight
Not available on Non-Matrox computer
Available on Matrox 4Sight GP
function map Function map
Examples
None.
MsysIoFree
Next
Synopsis
Inquire about an I/O command list setting.
Syntax
MIL_INT MsysIoInquire(
MIL_ID IoCmdListSysId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about the specified I/O command list setting.

Note that you can use MsysIoControl() to control specific I/O command list settings.

[Matrox-4sight-GP]

This function is only available on Matrox 4Sight GPm.

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
IoCmdListSysId

Specifies the identifier of the I/O command list.

InquireType

Specifies the type of I/O command list 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):
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MsysIoInquire() 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 I/O command list settings.

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

function map For inquiring general I/O command list settings
CollapseInquireType Description
MIL system-specific
tooltip (†)
UserVarPtr
- Possible values returned
Collapse M_CLOCK_FREQUENCY

Inquires the frequency of the I/O command list's clock signal.

(summarize)
† a
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

† a
Collapse Value

Specifies the frequency of the I/O command list's clock, in Hz.

 † a
Collapse M_IO_COMMAND_COUNTER_ACTIVATION

Inquires which edge of the source signal is used to increment the I/O command list's internal counter. SET

(summarize)
† a
Collapse M_EDGE_FALLING

Specifies to use a high-to-low signal transition to increment the I/O command list's internal counter.

 † a
Collapse M_EDGE_RISING

Specifies to use a low-to-high signal transition to increment the I/O command list's internal counter.

 † a
Collapse M_IO_COMMAND_COUNTER_SOURCE

Inquires the signal to use as the counter source. SET

(summarize)
† a
Collapse UserVarPtr data type info

Data type: MIL_INT64

† a
Collapse M_AUX_IOn

Specifies to use auxiliary input signal n as the counter source, where n is the number for one of the auxiliary input signals. INFO

 † a
Collapse M_CLOCK

Specifies to use your hardware's clock signal as a counter source. INFO

 † a
Collapse M_ROTARY_ENCODERn

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

 † a
Collapse M_IO_COMMAND_LIST_NUMBER

Inquires which I/O command list is allocated. SET

(summarize)
† a
Collapse UserVarPtr data type info

Data type: MIL_INT64

† a
Collapse M_IO_COMMAND_LIST1

Specifies the first I/O command list.

 † a
Collapse M_IO_COMMAND_LIST2

Specifies the second I/O command list.

 † a
Collapse M_IO_OBJECT_TYPE

Inquires the type of I/O command list that is allocated. SET

(summarize)
† a
Collapse UserVarPtr data type info

Data type: MIL_INT64

† a
Collapse M_IO_COMMAND_LIST

Specifies a general I/O command list.

 † a
Collapse M_OWNER_SYSTEM

Inquires the MIL identifier (MIL_ID) of the system on which the I/O command list has been allocated. SET

(summarize)
† a
Collapse UserVarPtr data type info

Data type: MIL_ID

† a
Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application. INFO

 † a
Collapse MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc(). INFO

 † a
Collapse M_REFERENCE_VALUE

Inquires the I/O command list's internal counter value at the current moment (that is, the moment MsysIoInquire() is called).

(summarize)
† a
Collapse UserVarPtr data type info

Data type: MIL_INT64
Note: For 32-bit operating systems, an error will be returned if UserVarPtr is set to M_NULL.

† a
Collapse Value

Specifies the I/O command list's internal counter value.

 † a

The following inquire types allow you to inquire settings for one of the I/O command list's reference latches.

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

function map For inquiring reference latch settings
CollapseInquireType Description
MIL system-specific
tooltip (†)
UserVarPtr
- Possible values returned
Collapse M_REFERENCE_LATCH_ACTIVATION +

Inquires the signal transition upon which to store the time or counter value to the specified reference latch. SET


You must specify a combination value from the following table:
(summarize)
† a
Collapse M_ANY_EDGE

Specifies to store the time or counter value to the latch upon both a low-to-high and a high-to-low signal transition.

 † a
Collapse M_EDGE_FALLING

Specifies to store the time or counter value to the latch upon a high-to-low signal transition.

 † a
Collapse M_EDGE_RISING

Specifies to store the time or counter value to the latch upon a low-to-high signal transition.

 † a
Collapse M_REFERENCE_LATCH_STATE +

Inquires the state of the specified reference latch. SET


You must specify a combination value from the following table:
(summarize)
† a
Collapse M_DISABLE

Specifies the reference latch is disabled.

 † a
Collapse M_ENABLE

Specifies the reference latch is enabled.

 † a
Collapse M_REFERENCE_LATCH_TRIGGER_SOURCE +

Inquires which input signal will trigger storing the time or counter value to the specified reference latch. SET


You must specify a combination value from the following table:
(summarize)
† a
Collapse M_AUX_IOn

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

 † a
Collapse M_REFERENCE_LATCH_VALUE +

Inquires the last time or counter value stored by the specified reference latch.


You must specify a combination value from the following table:
(summarize)
† a
Collapse UserVarPtr data type info

Data type: MIL_INT64
Note: For 32-bit operating systems, an error will be returned if UserVarPtr is set to M_NULL.

† a
Collapse Value

Specifies the last timestamp or counter value stored by the specified reference latch.

 † a
Combination constant for the values listed in For inquiring reference latch settings.

You must add the following value to the above-mentioned values to specify which reference latch to inquire about.

function map For specifying the reference latch to inquire
CollapseCombination value Description
MIL system-specific
tooltip (†)
Collapse M_LATCHn

Specifies to inquire about reference latch n, where n is a number from 1 to 4.

 † a
Return value
The returned value is the requested information, usually cast to a MIL_INT.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
CLOCK FREQUENCY IO COMMAND COUNTER ACTIVATION EDGE FALLING EDGE RISING IO COMMAND COUNTER SOURCE AUX IOn CLOCK ROTARY ENCODERn IO COMMAND LIST NUMBER IO COMMAND LIST1 IO COMMAND LIST2 IO OBJECT TYPE IO COMMAND LIST OWNER SYSTEM DEFAULT HOST REFERENCE VALUE REFERENCE LATCH ACTIVATION ANY EDGE EDGE FALLING EDGE RISING REFERENCE LATCH STATE DISABLE ENABLE REFERENCE LATCH TRIGGER SOURCE AUX IOn REFERENCE LATCH VALUE LATCHn