| MIL 10 Reference
| Customize Help
| Save Settings

MfpgaCommandInquire


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Not supported on:
Not supported on Host system
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 USB3 Vision driver (requires Update 19)
Not supported on Matrox Vio
Fully supported on:
Fully supported on Matrox Radient eCL
Fully supported on Matrox Radient eV-CXP
Fully supported on Matrox Solios eA/XA
Fully supported on Matrox Solios ecl/xcl/ev-cl

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

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MfpgaCommandFree
MfpgaCommandQueue
Synopsis
Inquire about a specified FPGA command context setting.
Syntax
void MfpgaCommandInquire(
MIL_FPGA_CONTEXT FpgaCommandContext, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a specified FPGA command context setting.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
FpgaCommandContext

Specifies the handle of the FPGA command context associated with the PU.

InquireType

Specifies the type of setting about which to inquire. These inquire types correspond to register fields of the PU associated with the specified FPGA command context. This parameter can be set to one of the following values:

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

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • MIL_INT

Specifies the address in which to write the requested information.

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

Parameter associations

The table below lists possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

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

function map For specifying the type of setting
CollapseInquireType Description
MIL system-specific
tooltip (†)
UserVarPtr
- Possible values returned
Collapse M_CAPABILITY

Inquires a PU's capability. Capabilities are specific to each PU and are used to differentiate between multiple types of PUs that perform similar operations. For example, if you have two LUT PUs, one that can map 8-bit buffers and the other that can map 8-, 10-, and 12-bit buffers, you can inquire the capability value to differentiate the two. Refer to your PU's documentation for details on what capabilities are represented by what values.

(summarize)
† j k l m p q r
Collapse Value

Specifies the PU's capability as a value.

 † j k l m p q r
Collapse M_COMPLETION_MODE

Inquires how the processing operation is issued on the system command queue. SET SET

(summarize)
† j k l m p q r
Collapse M_ASYNCHRONOUS

Specifies that, after the command is queued, the thread continues executing without waiting for the operation to complete.

 † j k l m p q r
Collapse M_SYNCHRONOUS

Specifies that, after the command is queued, the thread waits for the processing operation to complete before continuing.

 † j k l m p q r
Collapse M_FUNCTION_ID

Inquires the PU's function identifier.

(summarize)
† j k l m p q r
Collapse Value

Specifies the PU's function identifier.

 † j k l m p q r
Collapse M_INSTANCE_ID

Inquires the PU's instance number.

(summarize)
† j k l m p q r
Collapse Value

Specifies the PU's instance number.

 † j k l m p q r
Collapse M_MAJOR_VERSION

Inquires the major version number of the PU.

(summarize)
† j k l m p q r
Collapse Value

Specifies the major version number of the PU.

 † j k l m p q r
Collapse M_MINOR_VERSION

Inquires the minor version number of the PU.

(summarize)
† j k l m p q r
Collapse Value

Specifies the minor version number of the PU.

 † j k l m p q r
Collapse M_NATIVE_ID

Inquires the native function identifier of the command context. This identifier can be used when mixing board-specific code (from the native library function set) with MIL code.

(summarize)
† j k l m p q r
Collapse Value

Specifies the native function identifier of the command context.

 † j k l m p q r
Collapse M_NUMBER_OF_EVENTS

Inquires the total number of interrupts that the PU can generate.

(summarize)
† j k l m p q r
Collapse Value

Specifies the total number of interrupts the PU can generate.

 † j k l m p q r
Collapse M_REG_IOCTL_OFFSET

Inquires the position of the I/O control register space, relative to the start of the PU's register space.

(summarize)
† j k l m p q r
Collapse Value

Specifies the postition of the I/O control register space, in quadwords.

 † j k l m p q r
Collapse M_REG_USER_FULL_SIZE

Inquires the size of the PU's entire register space, which includes the header, I/O control, and user-specific register sections.

(summarize)
† j k l m p q r
Collapse Value

Specifies the size ot the PU's register space, in quadwords.

 † j k l m p q r
Collapse M_REG_USER_OFFSET

Inquires the position of the user-specific register section, relative to the start of the PU's register space.

(summarize)
† j k l m p q r
Collapse Value

Specifies the postition of the user-specific register section, in quadwords.

 † j k l m p q r
Collapse M_REG_USER_SIZE

Inquires the size of the user-specific register section of the PU.

(summarize)
† j k l m p q r
Collapse Value

Specifies the size of the user-specific register section, in quadwords.

 † j k l m p q r
Collapse M_SUB_FUNCTION_ID

Inquires the PU's subfunction identifier.

(summarize)
† j k l m p q r
Collapse Value

Specifies the PU's subfunction identifier.

 † j k l m p q r
Compilation information
Header Include mil.h; milfpga.h.
Library Use mil.lib; milfpga.lib.
DLL Requires mil.dll; milfpga.dll.
CAPABILITY COMPLETION MODE ASYNCHRONOUS SYNCHRONOUS FUNCTION ID INSTANCE ID MAJOR VERSION MINOR VERSION NATIVE ID NUMBER OF EVENTS REG IOCTL OFFSET REG USER FULL SIZE REG USER OFFSET REG USER SIZE SUB FUNCTION ID