MfpgaInquire

See also

Reference:

MfpgaCommandInquire

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

Function Map

- MilSystemId

Table:

For specifying the rank of the Processing FPGA

- InquireType

- UserVarPtr

Parameter Associations

Table:

For FPGAs

Return value

Compilation information

Synopsis

Inquire global information about a specified Processing FPGA.

Syntax

MIL_INT MfpgaInquire(

MIL_ID MilSystemId,	//in
MIL_INT FpgaDeviceNumber,	//in
MIL_INT64 InquireType,	//in
void *UserVarPtr	//out

)

Description

This function inquires global information about a Processing FPGA, including all loaded PUs. See MfpgaCommandInquire() to retrieve information about a specific command context.

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

MilSystemId

Specifies the identifier of the system that has the required Processing FPGA.

FpgaDeviceNumber

Specifies the Processing FPGA to inquire. This parameter must be set to the following value:

For specifying the rank of the Processing FPGA
Value	Description	MIL system-specific tooltip (‡)
M_DEVn	Specifies the rank of the Processing FPGA about which to inquire, where n can be a value between 0 and the total number of Processing FPGAs-1.	‡	j	k M10	l	m	p	r U27	y U75	aa

InquireType

Specifies the information 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_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
MIL_INT

Specifies the address at which to write the requested information. Since the MfpgaInquire() 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 table below lists possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

For FPGAs

For FPGAs
InquireType		Description	MIL system-specific tooltip (‡)
	UserVarPtr - Possible values returned	Description
M_FPGA_CONFIGURATION_FILENAME		Inquires the string containing identifying information about the file name of the Processing FPGA configuration. The information consists of the location of the file (its path), followed by the name of the file (for example, "C:\mydirectory\myfile"). For a file on the remote computer (under Distributed MIL), the path and file name will be preceded by "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Inquires the string containing identifying information about the file name of the Processing FPGA configuration. (more details...)										‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MfpgaInquire ( M_FPGA_CONFIGURATION_FILENAME_LENGTH ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MfpgaInquire ( M_FPGA_CONFIGURATION_FILENAME_LENGTH ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size.	‡	j	k M10	l	m	p	r U27	y U75	aa
	MIL_TEXT("String") ¹	Specifies the string containing information about the file name.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_FPGA_CONFIGURATION_FILENAME_LENGTH		Inquires the length of the string returned by M_FPGA_CONFIGURATION_FILENAME. (summarize) Inquires the length of the string returned by M_FPGA_CONFIGURATION_FILENAME. (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 length of the string, including the terminating null character ("\0").	‡	j	k M10	l	m	p	r U27	y U75	aa
M_FPGA_PACKAGE_NAME		Inquires the string containing identifying information about the Processing FPGA on your board. The information consists of the specific package name, followed by an underscore, followed by the speed grade. (summarize) Inquires the string containing identifying information about the Processing FPGA on your board. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MfpgaInquire ( M_FPGA_PACKAGE_NAME_LENGTH ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MfpgaInquire ( M_FPGA_PACKAGE_NAME_LENGTH ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size.	‡	j	k M10	l	m	p	r U27	y U75	aa
	MIL_TEXT("String") ¹	Specifies the string containing information about the Processing FPGA.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_FPGA_PACKAGE_NAME_LENGTH		Inquires the length of the string returned by M_FPGA_PACKAGE_NAME. (summarize) Inquires the length of the string returned by M_FPGA_PACKAGE_NAME. (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 length of the string, including the terminating null character ("\0").	‡	j	k M10	l	m	p	r U27	y U75	aa
M_NUMBER_OF_PU		Inquires the number of PUs currently loaded in the Processing FPGA. (summarize) Inquires the number of PUs currently loaded in the Processing FPGA. (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 number of PUs.	‡	j	k M10	l	m	p	r U27	y U75	aa
M_PU_LIST		Inquires the list of function identifiers of all PUs currently loaded in the Processing FPGA. (summarize) Inquires the list of function identifiers of all PUs currently loaded in the Processing FPGA. (more details...)	‡	j	k M10	l	m	p	r U27	y U75	aa
	UserVarPtr extra info	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size: MfpgaInquire ( M_NUMBER_OF_PU ) Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size: MfpgaInquire ( M_NUMBER_OF_PU )	‡	j	k M10	l	m	p	r U27	y U75	aa
	Value	Specifies the function identifier.	‡	j	k M10	l	m	p	r U27	y U75	aa

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

Return value

The returned value is M_VALID if successful. If the operation fails, M_NULL is returned.

Compilation information

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