MfpgaCommandInquire

See also

Reference:

MfpgaCommandAlloc MfpgaCommandControl

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Host system (a)

Not supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Not supported on Matrox Morphis (g)

Not supported on Matrox Morphis QxT (h)

Not supported on Matrox Orion HD (i)

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

Not supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Not supported on Matrox Clarity UHD (Update 36 or 76) (u)

Not supported on Matrox GenTL driver (Update 34) (v)

Not supported on Matrox Indio (Update 53 or Update 68) (w)

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

Fully supported on:

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

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

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

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

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

None.

Function Map

Parameter Associations

Table:

For specifying the type of setting

Compilation information

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.

For specifying the type of setting

For specifying the type of setting
InquireType		Description	MIL system-specific tooltip (‡)
	UserVarPtr - Possible values returned	Description
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) Inquires a PU's capability. (more details...)										‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the PU's capability as a value.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_COMPLETION_MODE		Inquires how the processing operation is issued on the system command queue. SET SET (summarize) Inquires how the processing operation is issued on the system command queue. SET SET (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	M_ASYNCHRONOUS	Specifies that, after the command is queued, the thread continues executing without waiting for the operation to complete.	‡	j	k M10	l	m	p	r U27	y U75	aa
	M_SYNCHRONOUS	Specifies that, after the command is queued, the thread waits for the processing operation to complete before continuing.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_FUNCTION_ID		Inquires the PU's function identifier. (summarize) Inquires the PU's function identifier. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the PU's function identifier.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_MAJOR_VERSION		Inquires the major version number of the PU. (summarize) Inquires the major version number of the PU. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the major version number of the PU.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_MINOR_VERSION		Inquires the minor version number of the PU. (summarize) Inquires the minor version number of the PU. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the minor version number of the PU.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_NUMBER_OF_EVENTS		Inquires the total number of interrupts that the PU can generate. (summarize) Inquires the total number of interrupts that the PU can generate. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the total number of interrupts the PU can generate.	‡	j	k M10	l	m	p	r U27	y U75	aa
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) Inquires the position of the I/O control register space, relative to the start of the PU's register space. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the postition of the I/O control register space, in quadwords.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_REG_USER_OFFSET		Inquires the position of the user-specific register section, relative to the start of the PU's register space. (summarize) Inquires the position of the user-specific register section, relative to the start of the PU's register space. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the postition of the user-specific register section, in quadwords.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_REG_USER_SIZE		Inquires the size of the user-specific register section of the PU. (summarize) Inquires the size of the user-specific register section of the PU. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the size of the user-specific register section, in quadwords.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_SUB_FUNCTION_ID		Inquires the PU's subfunction identifier. (summarize) Inquires the PU's subfunction identifier. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the PU's subfunction identifier.	‡	j	k M10	l	m	p	r U27	y U75	aa

Compilation information

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