MfuncInquire

See also

User Guide:

Associating a MIL identifier with a user-defined object Source and destination image buffers Steps to develop a function that performs an operation using a Processing FPGA

Reference:

MbufAlloc2d MfuncAlloc MfuncAllocId MfuncAllocScript MfuncControl

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

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 Host system (a)

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

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

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 USB3 Vision driver (Update 19) (o)

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 Iris GTR (Update 28 or Update 68) (t)

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

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

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

fdkoffsetgainlutmapprimitive.cpp
fdkoffsetgainprimitive.cpp
lutmapprimitive.cpp

Function Map

- MilObjectId

Parameter Associations

Table:	For different MIL object types
Table:	For user-defined MIL functions
+ combination:	For specifying the number of the parameter for which to inquire the information
Table:	For the script-based user-defined MIL object feature
+ combination:	For specifying the index number of the script reference to be inquired.
+ combination:	For inquiring the size of a string

Return value

Compilation information

Synopsis

Retrieve information about a MIL object.

Syntax

MIL_INT MfuncInquire(

MIL_ID MilObjectId,	//in
MIL_INT64 InquireType,	//in
void *UserVarPtr	//out

)

Description

This function retrieves information about the specified MIL object.

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

MilObjectId

Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function.

InquireType

Specifies the MIL object feature 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 [optionally, in C++: a reference to a MIL_STRING]
address_to_a_pointer
MIL_BUFFER_INFO
MIL_INT

Specifies the address in which to write the requested information. Since the MfuncInquire() 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.

For different MIL object types
For user-defined MIL functions
For the script-based user-defined MIL object feature

The following InquireType parameter settings can be specified for different MIL object types.

For different MIL object types
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_BUFFER_INFO		Inquires the handle of the MIL buffer. This buffer must have been allocated using one of the MbufAlloc...() functions. (summarize) Inquires the handle of the MIL buffer. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_BUFFER_INFO Data type: address of a MIL_BUFFER_INFO Data type info: Data type: address of a MIL_BUFFER_INFO Data type: address of a MIL_BUFFER_INFO
M_OBJECT_PTR		Inquires the address of the user-defined MIL object allocated using MfuncAllocId(). (summarize) Inquires the address of the user-defined MIL object allocated using MfuncAllocId(). (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a address_to_a_pointer Data type: address of a address_to_a_pointer Data type info: Data type: address of a address_to_a_pointer Data type: address of a address_to_a_pointer

The following InquireType parameter settings can be specified when the object passed to MilObjectId is a user-defined MIL function context allocated using MfuncAlloc() or MfuncAllocScript().

For user-defined MIL functions
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_CALLER_BITNESS		Inquires the bitness of the operating system on which the function context was created. (summarize) Inquires the bitness of the operating system on which the function context was created. (more details...)
	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
	32	Specifies a 32-bit platform.
	64	Specifies a 64-bit platform.
M_PARAM_NUMBER		Inquires the number of parameters associated with the specified user-defined MIL function context. (summarize) Inquires the number of parameters associated with the specified user-defined MIL function context. (more details...)
	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
M_PARAM_SIZE +		Inquires the size, in bytes, of the specified parameter. For an array parameter, the size is: Number of items in the array X Size of the item. You must specify a combination value from the following table: To determine the number of the parameter for which to receive the information (summarize) Inquires the size, in bytes, of the specified parameter. (more details...)
	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
M_PARAM_TYPE_INFO +		Inquires the data type of the specified parameter. You must specify a combination value from the following table: To determine the number of the parameter for which to receive the information (summarize) Inquires the data type of the specified parameter. (more details...)
	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
	M_PARAM_TYPE_ARRAY_MIL_DOUBLE	Specifies that the parameter is an array of type MIL_DOUBLE. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_DOUBLE. (more details...)
	M_PARAM_TYPE_ARRAY_MIL_ID	Specifies that the parameter is an array of type MIL_ID. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_ID. (more details...)
	M_PARAM_TYPE_ARRAY_MIL_INT	Specifies that the parameter is an array of type MIL_INT. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_INT. (more details...)
	M_PARAM_TYPE_ARRAY_MIL_INT32	Specifies that the parameter is an array of type MIL_INT32. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_INT32. (more details...)
	M_PARAM_TYPE_ARRAY_MIL_INT64	Specifies that the parameter is an array of type MIL_INT64. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_INT64. (more details...)
	M_PARAM_TYPE_ARRAY_MIL_UINT	Specifies that the parameter is an array of type MIL_UINT. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_UINT. (more details...)
	M_PARAM_TYPE_ARRAY_MIL_UINT32	Specifies that the parameter is an array of type MIL_UINT32. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_UINT32. (more details...)
	M_PARAM_TYPE_ARRAY_MIL_UINT64	Specifies that the parameter is an array of type MIL_UINT64. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is an array of type MIL_UINT64. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_DOUBLE	Specifies that the parameter is a constant array of type MIL_DOUBLE. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_DOUBLE. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_ID	Specifies that the parameter is a constant array of type MIL_ID. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_ID. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_INT	Specifies that the parameter is a constant array of type MIL_INT. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_INT. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_INT32	Specifies that the parameter is a constant array of type MIL_INT32. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_INT32. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_INT64	Specifies that the parameter is a constant array of type MIL_INT64. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_INT64. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_UINT	Specifies that the parameter is a constant array of type MIL_UINT. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_UINT. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_UINT32	Specifies that the parameter is a constant array of type MIL_UINT32. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_UINT32. (more details...)
	M_PARAM_TYPE_CONST_ARRAY_MIL_UINT64	Specifies that the parameter is a constant array of type MIL_UINT64. Note that the pointer to the data stored in the array is unavailable after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant array of type MIL_UINT64. (more details...)
	M_PARAM_TYPE_CONST_DATA_PTR	Specifies that the parameter is a constant data pointer. Note that the pointer to the data is invalid after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a constant data pointer. (more details...)
	M_PARAM_TYPE_CONST_MIL_TEXT	Specifies that the parameter is a constant of type MIL_TEXT. This implies that the character encoding scheme of the MIL_TEXT parameter is the scheme you are currently using. (summarize) Specifies that the parameter is a constant of type MIL_TEXT. (more details...)
	M_PARAM_TYPE_CONST_MIL_TEXT_ASCII	Specifies that the parameter is a constant of type MIL_TEXT_ASCII. This only appears when you are currently using a character encoding scheme other than ASCII, and the parameter you are inquiring is specifically in ASCII. (summarize) Specifies that the parameter is a constant of type MIL_TEXT_ASCII. (more details...)
	M_PARAM_TYPE_CONST_MIL_TEXT_UNICODE	Specifies that the parameter is a constant of type MIL_TEXT_UNICODE. This only appears when you are currently using a character encoding scheme other than unicode, and the parameter you are inquiring is specifically in unicode. (summarize) Specifies that the parameter is a constant of type MIL_TEXT_UNICODE. (more details...)
	M_PARAM_TYPE_DATA_PTR	Specifies that the parameter is a data pointer. Note that the pointer to the data is invalid after exiting the user-defined function. For future use, copy and save the data. (summarize) Specifies that the parameter is a data pointer. (more details...)
	M_PARAM_TYPE_FILENAME	Specifies that the parameter is of type FILENAME. This implies that the character encoding scheme of the FILENAME parameter is the scheme you are currently using. (summarize) Specifies that the parameter is of type FILENAME. (more details...)
	M_PARAM_TYPE_FILENAME_ASCII	Specifies that the parameter is of type FILENAME_ASCII. This only appears when you are currently using a character encoding scheme other than ASCII, and the parameter you are inquiring is specifically in ASCII. (summarize) Specifies that the parameter is of type FILENAME_ASCII. (more details...)
	M_PARAM_TYPE_FILENAME_UNICODE	Specifies that the parameter is of type FILENAME_UNICODE. This only appears when you are currently using a character encoding scheme other than unicode, and the parameter you are inquiring is specifically in unicode. (summarize) Specifies that the parameter is of type FILENAME_UNICODE. (more details...)
	M_PARAM_TYPE_MIL_DOUBLE	Specifies that the parameter is of type MIL_DOUBLE.
	M_PARAM_TYPE_MIL_ID	Specifies that the parameter is of type MIL_ID.
	M_PARAM_TYPE_MIL_INT	Specifies that the parameter is of type MIL_INT.
	M_PARAM_TYPE_MIL_INT32	Specifies that the parameter is of type MIL_INT32.
	M_PARAM_TYPE_MIL_INT64	Specifies that the parameter is of type MIL_INT64.
	M_PARAM_TYPE_MIL_TEXT	Specifies that the parameter is of type MIL_TEXT. This implies that the character encoding scheme of the MIL_TEXT parameter is the scheme you are currently using. (summarize) Specifies that the parameter is of type MIL_TEXT. (more details...)
	M_PARAM_TYPE_MIL_TEXT_ASCII	Specifies that the parameter is of type MIL_TEXT_ASCII. This only appears when you are currently using a character encoding scheme other than ASCII, and the parameter you are inquiring is specifically in ASCII. (summarize) Specifies that the parameter is of type MIL_TEXT_ASCII. (more details...)
	M_PARAM_TYPE_MIL_TEXT_UNICODE	Specifies that the parameter is of type MIL_TEXT_UNICODE. This only appears when you are currently using a character encoding scheme other than unicode, and the parameter you are inquiring is specifically in unicode. (summarize) Specifies that the parameter is of type MIL_TEXT_UNICODE. (more details...)
	M_PARAM_TYPE_MIL_UINT	Specifies that the parameter is of type MIL_UINT.
	M_PARAM_TYPE_MIL_UINT32	Specifies that the parameter is of type MIL_UINT32.
	M_PARAM_TYPE_MIL_UINT64	Specifies that the parameter is of type MIL_UINT64.

Combination value for M_PARAM_SIZE; M_PARAM_TYPE_INFO.

You must add the following value to the above-mentioned values to determine the number of the parameter for which to receive the information.

For specifying the number of the parameter for which to inquire the information
Combination value	Description
Value >= 1	Specifies the number of the parameter for which to inquire the information. This value must be a positive integer, and should not exceed the number of parameters associated with the MIL function context (M_PARAM_NUMBER). (summarize) Specifies the number of the parameter for which to inquire the information. (more details...)

The following InquireType parameter settings can be specified when the object passed to MilObjectId is a script-based user-defined MIL function context allocated using MfuncAllocScript().

For the script-based user-defined MIL object feature
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_COMPILE		Inquires whether the script must be reloaded from disk and recompiled. SET (summarize) Inquires whether the script must be reloaded from disk and recompiled. SET (more details...)
	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
	M_MODIFIED	Specifies that the script is recompiled only if the file on disk has changed.
	M_ONCE	Specifies that the script is only compiled once.
M_DEBUG_INFORMATION		Inquires whether the interpreter interface DLL generates debug information for the script. SET (summarize) Inquires whether the interpreter interface DLL generates debug information for the script. SET (more details...)
	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
	M_NO	Specifies that the script is compiled in release mode, using optimization flags.
	M_YES	Specifies that the script is compiled in debug mode, and that the necessary debug information is generated. INFO
M_DEBUG_INFORMATION_PATH +		Inquires the path of the directory in which the compiled version of the script and other files are created, if they are relevant for the scripting language. SET (summarize) Inquires the path of the directory in which the compiled version of the script and other files are created, if they are relevant for the scripting language. SET (more details...)
	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: MfuncInquire ( M_DEBUG_INFORMATION_PATH + M_STRING_SIZE ) 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: MfuncInquire ( M_DEBUG_INFORMATION_PATH + M_STRING_SIZE ) 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.
M_NUMBER_OF_SCRIPT_REFERENCES		Inquires the number of DLLs that are included in the list of DLLs referred to during runtime. (summarize) Inquires the number of DLLs that are included in the list of DLLs referred to during runtime. (more details...)
	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
	Value	Specifies the number of DLLs in the list.
M_SCRIPT_REFERENCE +		Inquires the path of the specified DLL in the list of DLLs referred to during runtime. SET You must specify a combination value from the following table: To specify the index number of the script reference to be inquired (summarize) Inquires the path of the specified DLL in the list of DLLs referred to during runtime. SET (more details...)
	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: MfuncInquire ( M_SCRIPT_REFERENCE + M_STRING_SIZE ) 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: MfuncInquire ( M_SCRIPT_REFERENCE + M_STRING_SIZE ) 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.

Combination value for M_SCRIPT_REFERENCE.

You must add the following value to the above-mentioned value to specify the index number of the script reference to be inquired.

For specifying the index number of the script reference to be inquired.
Combination value	Description
Value >= 1	Specifies the index of the script reference about which to inquire. This value must be a positive integer. (summarize) Specifies the index of the script reference about which to inquire. (more details...)

Combination value for M_DEBUG_INFORMATION_PATH; M_SCRIPT_REFERENCE.

You can add the following value to the above-mentioned values to get the string's length.

For inquiring the size of a string
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_STRING_SIZE		Inquires the number of characters in the string. This number accounts for every character, including the terminating null character. (summarize) Inquires the number of characters in the string. (more details...)
	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

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.

Compilation information

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