| MIL 10 Reference
| Customize Help
| Save Settings

MappInquire


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows with restrictions
Available on Linux with restrictions

Available on Matrox 4Sight GP with restrictions
Available on Matrox 4Sight-X with restrictions
Available on Matrox Supersight with restrictions
Available on Non-Matrox computer with restrictions
function map Function map
Examples
MappHookFunction
MappInquireConnection
Synopsis
Inquire about an application setting.
Syntax
MIL_INT MappInquire(
MIL_ID ContextAppId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about the specified application 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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
ContextAppId

Specifies the identifier of the application context to use.

function map For specifying the application context
CollapseValue Description
Collapse M_DEFAULT

Specifies the current application context.
Collapse Application Context Identifier

Specifies the application context identifier.
InquireType

Specifies the type of application setting about which to inquire. This parameter can be set to one of the values below.

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
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT

Specifies the address in which to write the requested information.

Since the MappInquire() 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 about general types of application settings.

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

function map For inquiring about general types of application settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_CURRENT_APPLICATION

Inquires the identifier of the current MIL application, if any.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_ID

Collapse 0

Specifies that no application is allocated. Note that no error is generated.

(summarize)
Collapse MIL application identifier

Specifies the identifier of the current MIL application.
Collapse M_DIRECTX_VERSION
[This is only applicable to Windows]

Inquires the version of DirectX that MIL can use for display purposes under Windows. This determines the hardware acceleration display mode. SET

(summarize)
Collapse 0

Specifies that DirectX cannot be used. INFO
Collapse 9 <= Value <= 11

Specifies that either DirectX version 9.0, 10.0, or 11.0 can be used, respectively. INFO
Collapse M_DMIL_CONNECTION

Inquires the Distributed MIL monitoring configuration permission level. SET

(summarize)
Collapse M_DISABLE

Specifies that Distributed MIL monitoring configuration is disabled in the current application. INFO
Collapse M_DMIL_CONTROL

Specifies that MIL objects in the current application can be accessed with either read only or read/write permission, depending on how that MIL object was specified with MappControlObject().
Collapse M_DMIL_MONITOR

Specifies that MIL objects in the current application can be accessed only with read only permission, regardless of how that MIL object was specified with MappControlObject().
Collapse M_DMIL_CONNECTION_PORT

Inquires the listening port of a publishing application in the Distributed MIL monitoring configuration. SET

(summarize)
Collapse Listening port

Specifies the listening port (an integer between 0 and 65535) that the current application will use to listen for connections from a monitoring application.
Collapse M_ERROR +

Inquires the error printing mode. SET

(summarize)
Collapse M_PRINT_DISABLE

Specifies not to print error messages. INFO
Collapse M_PRINT_ENABLE

Specifies to print error messages.
Collapse M_THROW_EXCEPTION

Specifies that when an error occurs, a .NET exception will be thrown instead of a message box being displayed.

M_THROW_EXCEPTION is only valid when working in a .NET environment.

(summarize)
Collapse M_ERROR_HOOKS

Inquires whether an error event type (specified using MappHookFunction() set to M_ERROR_CURRENT, M_ERROR_GLOBAL, or M_ERROR_FATAL) will trigger the user defined function specified in MappHookFunction(). SET

(summarize)
Collapse M_DISABLE

Specifies to not trigger the user defined function when an error event type occurs, as specified in MappHookFunction(). INFO
Collapse M_ENABLE

Specifies to trigger the user defined function when an error event type occurs, as specified in MappHookFunction().
Collapse M_INSTALLED_SYSTEM_COUNT

Inquires the number of different system types installed during MIL installation.

(summarize)
Collapse Value

Specifies the number of different system types installed.
Collapse M_INSTALLED_SYSTEM_DESCRIPTOR + n

Inquires the descriptor of system type n, where n is a number between 0 and the value returned by M_INSTALLED_SYSTEM_COUNT. The descriptor can be passed to MsysAlloc() to allocate the system. SET

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_TEXT_CHAR
Array size: The size of the array must be large enough to store the entire system descriptor.

Collapse M_SYSTEM_1394

Specifies a MIL IEEE 1394b IIDC system.
Collapse M_SYSTEM_CRONOSPLUS

Specifies a MIL CronosPlus system.
Collapse M_SYSTEM_DEFAULT

Specifies the default system. INFO
Collapse M_SYSTEM_GIGE_VISION

Specifies a MIL GigE Vision system. INFO
Collapse M_SYSTEM_GPU

Specifies a MIL GPU system.
Collapse M_SYSTEM_HOST

Specifies a Host system. INFO
Collapse M_SYSTEM_IRIS_GT

Specifies a MIL Iris GT system.
Collapse M_SYSTEM_MORPHIS

Specifies a MIL Morphis system.
Collapse M_SYSTEM_MORPHISQXT

Specifies a MIL Morphis QxT system.
Collapse M_SYSTEM_ORION_HD

Specifies a MIL Orion HD system.
Collapse M_SYSTEM_RADIENT

Specifies a MIL Radient system.
Collapse M_SYSTEM_RADIENTCLHS

Specifies a MIL Radient eV-CLHS system.
Collapse M_SYSTEM_RADIENTCXP

Specifies a MIL Radient eV-CXP system.
Collapse M_SYSTEM_RADIENTEVCL

Specifies a MIL Radient eV-CL system.
Collapse M_SYSTEM_RADIENTPRO

Specifies a MIL Radient Pro Camera-Link system.
Collapse M_SYSTEM_SOLIOS

Specifies a MIL Solios system.
Collapse M_SYSTEM_USB3_VISION

Specifies a MIL USB3 Vision system. INFO
Collapse M_SYSTEM_VIO

Specifies a MIL Vio system.
Collapse MIL_TEXT("dmilpcie://[Passkey:]RemoteComputerName[:Port]/MILSystemType") 1

Specifies a DMIL remote system on a remote Matrox Supersight SHB that will communicate with the local SHB, using the PCIe protocol. INFO
Collapse MIL_TEXT("dmilshm://[Passkey:]localhost[:Port]/MILSystemType") 1

Specifies a DMIL remote system for a separate process on the local computer, using the DMIL SHM protocol. INFO
Collapse MIL_TEXT("dmiltcp://[Passkey:]RemoteComputerName[:Port]/MILSystemType") 1

Specifies a DMIL remote system on a remote or local computer, using the TCP/IP protocol. INFO
Collapse M_INSTALLED_SYSTEM_DESCRIPTOR_SIZE

Inquires the size of the descriptor string of a system.

(summarize)
Collapse Value

Specifies the size of the descriptor string.
Collapse M_INSTALLED_SYSTEM_PRINT_NAME + n

Inquires the printable name of system type n (for example, Matrox Radient), where n is a number between 0 and the value returned by M_INSTALLED_SYSTEM_COUNT.

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_TEXT_CHAR
Array size: The size of the array must be large enough to store the entire printable name of the system.

Collapse String

Specifies the printable name of system type n.
Collapse M_INSTALLED_SYSTEM_PRINT_NAME_SIZE

Inquires the size of the printable name of a system.

(summarize)
Collapse Value

Specifies the size of the system's printable name.
Collapse M_INSTALLED_SYSTEM_TYPE + n

Inquires the type of system type n, where n is a number between 0 and the value returned by M_INSTALLED_SYSTEM_COUNT. SET

(summarize)
Collapse M_SYSTEM_1394_TYPE

Specifies a MIL IEEE 1394 IIDC system.
Collapse M_SYSTEM_CRONOSPLUS_TYPE

Specifies a MIL CronosPlus system.
Collapse M_SYSTEM_GIGE_VISION_TYPE

Specifies a MIL GigE Vision system.
Collapse M_SYSTEM_GPU_TYPE

Specifies a MIL GPU system.
Collapse M_SYSTEM_HOST_TYPE

Specifies the Host.
Collapse M_SYSTEM_IRIS_GT_TYPE

Specifies a MIL Iris GT system.
Collapse M_SYSTEM_MORPHIS_TYPE

Specifies a MIL Morphis system.
Collapse M_SYSTEM_MORPHISQXT_TYPE

Specifies a MIL Morphis QxT system.
Collapse M_SYSTEM_ORION_HD_TYPE

Specifies a MIL Orion HD system.
Collapse M_SYSTEM_RADIENT_TYPE

Specifies a MIL Radient system.
Collapse M_SYSTEM_RADIENTCLHS_TYPE

Specifies a MIL Radient eV-CLHS system.
Collapse M_SYSTEM_RADIENTCXP_TYPE

Specifies a MIL Radient eV-CXP system.
Collapse M_SYSTEM_RADIENTEVCL_TYPE

Specifies a MIL Radient eV-CL system.
Collapse M_SYSTEM_RADIENTPRO_TYPE

Specifies a MIL Radient Pro system.
Collapse M_SYSTEM_SOLIOS_TYPE

Specifies a MIL Solios system.
Collapse M_SYSTEM_USB3_VISION_TYPE

Specifies a MIL USB3 Vision system.
Collapse M_SYSTEM_VIO_TYPE

Specifies a MIL Vio system.
Collapse M_LICENSE_MODULES

Inquires the modules for which there is a valid license. The value returned will be a bitwise combination of the following.

(summarize)
Collapse M_LICENSE_3DCA

Specifies a 3D calibration module license.
Collapse M_LICENSE_3DMAP

Specifies a 3D Reconstruction module license.
Collapse M_LICENSE_BEAD

Specifies a Bead module license.
Collapse M_LICENSE_BLOB

Specifies a Blob analysis module license.
Collapse M_LICENSE_CAL

Specifies a Calibration module license.
Collapse M_LICENSE_CODE

Specifies a Code read/write module license.
Collapse M_LICENSE_COL

Specifies a Color Analysis module license.
Collapse M_LICENSE_DEBUG

Specifies a development license.
Collapse M_LICENSE_DMIL

Specifies a Distributed MIL license.
Collapse M_LICENSE_EDGE

Specifies an Edge Finder module license.
Collapse M_LICENSE_GPU

Specifies a Matrox GPU driver license.
Collapse M_LICENSE_IM

Specifies an Image Processing module license.
Collapse M_LICENSE_INTERFACE

Specifies a Matrox IEEE1394 IIDC driver and Matrox GigE Vision driver license.
Collapse M_LICENSE_JPEG2000

Specifies a JPEG2000 compression license.
Collapse M_LICENSE_JPEGSTD

Specifies a JPEG compression license.
Collapse M_LICENSE_LITE

Specifies a MIL-Lite module license.
Collapse M_LICENSE_MEAS

Specifies a Measurement module license.
Collapse M_LICENSE_MET

Specifies a Metrology module license.
Collapse M_LICENSE_MOD

Specifies a Geometric Model Finder module license.
Collapse M_LICENSE_OCR

Specifies an OCR module license.
Collapse M_LICENSE_PAT

Specifies a Pattern Matching module license.
Collapse M_LICENSE_REG

Specifies a Registration module license.
Collapse M_LICENSE_STR

Specifies a String Reader module license.
Collapse M_MEMORY +

Inquires the memory compensation mode. SET

(summarize)
Collapse M_COMPENSATION_DISABLE

Specifies that on-board memory compensation is disabled. INFO
Collapse M_COMPENSATION_ENABLE

Specifies that on-board memory compensation is enabled.
Collapse M_NON_PAGED_MEMORY_FREE

Inquires the amount of free non-paged memory reserved for MIL (at installation time or using the MILConfig utility).

(summarize)
Collapse Value

Specifies the amount of free non-paged memory, in bytes.
Collapse M_NON_PAGED_MEMORY_SIZE

Inquires the amount of the non-paged memory (DMA) reserved for MIL.

(summarize)
Collapse Value

Specifies the amount of the non-paged memory (DMA) reserved for MIL, in bytes.
Collapse M_NON_PAGED_MEMORY_USED

Inquires the amount of non-paged memory being used.

(summarize)
Collapse Value

Specifies the amount of non-paged memory being used, in bytes.
Collapse M_PARAMETER +

Inquires the parameter checking mode. SET

(summarize)
Collapse M_CHECK_DISABLE

Specifies that checking of parameters is disabled. INFO
Collapse M_CHECK_ENABLE

Specifies that checking of parameters is enabled.
Collapse M_PLATFORM_BITNESS

Inquires the bitness of the MIL application.

(summarize)
Collapse 32

Specifies that the specified application is 32-bit.
Collapse 64

Specifies that the specified application is 64-bit.
Collapse M_PLATFORM_OS_TYPE

Inquires the operating system the specified MIL application is running on.

(summarize)
Collapse M_OS_LINUX

Specifies that the specified application is running on a Linux OS.
Collapse M_OS_RTX

Specifies that the specified application is running on an Interval Zero RTX OS.
Collapse M_OS_WINDOWS

Specifies that the specified application is running on a Microsoft Windows OS.
Collapse M_OS_WINDOWS_CE

Specifies that the specified application is running on a Microsoft Windows Embedded Compact OS.
Collapse M_PROCESSING +

Inquires the processing compensation mode. SET

(summarize)
Collapse M_COMPENSATION_DISABLE

Specifies that on-board processing compensation is disabled. INFO
Collapse M_COMPENSATION_ENABLE

Specifies that on-board processing compensation is enabled. INFO
Collapse M_TRACE +

Inquires the trace setting, which is used to start or stop generating a trace log.

Note that this inquire type can return M_DEFAULT, a trace setting which can signify either to start or to stop generating a trace log. Use M_TRACE_ACTIVE to determine if a trace log is currently being generated.

(summarize)
Collapse M_DEFAULT

Specifies the default trace setting, which either enables or disables generating a trace log, based on whether Matrox Profiler (or Matrox Interactive log) was used to start generating the log. INFO
Collapse M_LOG_DISABLE

Specifies the log disable setting, which stops generating the trace log.
Collapse M_LOG_ENABLE

Specifies the log enable setting, which starts generating the trace log.
Collapse M_TRACE_ACTIVE

Inquires whether a trace log is currently being generated in the current thread.

Note that adding the combination constant M_THREAD_CURRENT to this inquire will result in an error.

(summarize)
Collapse M_NO

Specifies that a trace log is not currently being generated in the current thread.
Collapse M_YES

Specifies that a trace log is currently being generated in the current thread.
Collapse M_VERSION

Inquires the version of the MIL library.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the version of the MIL library.
Collapse M_XORG_ACCELERATION
[This is only applicable to Linux]

Inquires whether MIL can use X11 (Xorg) acceleration for display under Linux. This determines the hardware acceleration display mode. SET

(summarize)
Collapse 0

Specifies that X11 acceleration cannot be used. INFO
Collapse 1

Specifies that X11 acceleration can be used. INFO

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

Combination constant for M_ERROR; M_MEMORY; M_PARAMETER; M_PROCESSING; M_TRACE.

You can add the following value to the above-mentioned values to specify that the inquire should be limited to the current thread.

In multi-thread environments, by default, you can inquire about an application setting from any thread.

function map For M_ERROR, M_MEMORY, M_PARAMETER, M_PROCESSING, and M_TRACE
CollapseCombination value Description
Collapse M_THREAD_CURRENT

Specifies that data to be returned should relate to the current thread.

When inquired and present, the requested system fingerprint is returned. If that specific fingerprint is not present, 0 is returned. For more information about system fingerprints, see the Protecting your own MIL software application using a Matrox hardware fingerprint section of Chapter 32: Distribution and licensing.

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

function map For inquiring system fingerprints
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_4SIGHTGP_FINGERPRINT
[This is only applicable to Matrox 4Sight GP platform]

Inquires the hardware fingerprint of a Matrox 4Sight-GP.

(summarize)
Collapse 0

Specifies that the current computer is not a Matrox 4Sight-GP.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_4SIGHTX_FINGERPRINT
[This is only applicable to Matrox 4Sight-X platform]

Inquires the hardware fingerprint of a Matrox 4Sight-X.

(summarize)
Collapse 0

Specifies that the current computer is not a Matrox 4Sight-X.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_ANY_FINGERPRINT

Inquires any hardware fingerprint.

(summarize)
Collapse 0

Specifies that no hardware that has been correctly installed has a fingerprint.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_CONCORD_1394_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Concord 1394 board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_CONCORD_GIGE_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Concord GigE Vision board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_CRONOSPLUS_FINGERPRINT

Inquires the hardware fingerprint of a Matrox CronosPlus board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_ID_KEY_FINGERPRINT

Inquires the hardware fingerprint of a hardware identification key. The hardware identification key is the device, which when connected to your USB or parallel port, you can use as a hardware fingerprint to generate a software license.

(summarize)
Collapse 0

Specifies that the hardware identification key is not connected to the computer, or that it is not correctly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_IRISGT_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Iris GT.

(summarize)
Collapse 0

Specifies that the current computer is not a Matrox Iris GT.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_MSERIES_FINGERPRINT

Inquires the hardware fingerprint of a Matrox M-Series board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_ORIONHD_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Orion HD board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_RADIENT_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Radient board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_RADIENTCXP_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Radient eV-CXP board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_SOLIOS_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Solios board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_SUPERSIGHT_FINGERPRINT
[This is only applicable to Matrox Supersight platform]

Inquires the hardware fingerprint of a Matrox Supersight.

(summarize)
Collapse 0

Specifies that the current computer is not a Matrox Supersight.
Collapse Value

Specifies the hardware fingerprint.
Collapse M_VIO_FINGERPRINT

Inquires the hardware fingerprint of a Matrox Vio board.

(summarize)
Collapse 0

Specifies that the board is not present in the computer, or that the board is incorrectly installed.
Collapse Value

Specifies the hardware fingerprint.
Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information is not a single value, or cannot be cast to a MIL_INT, this function will return M_NULL.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
DEFAULT CURRENT APPLICATION DIRECTX VERSION DMIL CONNECTION DISABLE DMIL CONTROL DMIL MONITOR DMIL CONNECTION PORT ERROR PRINT DISABLE PRINT ENABLE THROW EXCEPTION ERROR HOOKS DISABLE ENABLE INSTALLED SYSTEM COUNT INSTALLED SYSTEM DESCRIPTOR n SYSTEM 1394 SYSTEM CRONOSPLUS SYSTEM DEFAULT SYSTEM GIGE VISION SYSTEM GPU SYSTEM HOST SYSTEM IRIS GT SYSTEM MORPHIS SYSTEM MORPHISQXT SYSTEM ORION HD SYSTEM RADIENT SYSTEM RADIENTCLHS SYSTEM RADIENTCXP SYSTEM RADIENTEVCL SYSTEM RADIENTPRO SYSTEM SOLIOS SYSTEM USB3 VISION SYSTEM VIO INSTALLED SYSTEM DESCRIPTOR SIZE INSTALLED SYSTEM PRINT NAME n INSTALLED SYSTEM PRINT NAME SIZE INSTALLED SYSTEM TYPE n SYSTEM 1394 TYPE SYSTEM CRONOSPLUS TYPE SYSTEM GIGE VISION TYPE SYSTEM GPU TYPE SYSTEM HOST TYPE SYSTEM IRIS GT TYPE SYSTEM MORPHIS TYPE SYSTEM MORPHISQXT TYPE SYSTEM ORION HD TYPE SYSTEM RADIENT TYPE SYSTEM RADIENTCLHS TYPE SYSTEM RADIENTCXP TYPE SYSTEM RADIENTEVCL TYPE SYSTEM RADIENTPRO TYPE SYSTEM SOLIOS TYPE SYSTEM USB3 VISION TYPE SYSTEM VIO TYPE LICENSE MODULES LICENSE 3DCA LICENSE 3DMAP LICENSE BEAD LICENSE BLOB LICENSE CAL LICENSE CODE LICENSE COL LICENSE DEBUG LICENSE DMIL LICENSE EDGE LICENSE GPU LICENSE IM LICENSE INTERFACE LICENSE JPEG2000 LICENSE JPEGSTD LICENSE LITE LICENSE MEAS LICENSE MET LICENSE MOD LICENSE OCR LICENSE PAT LICENSE REG LICENSE STR MEMORY COMPENSATION DISABLE COMPENSATION ENABLE NON PAGED MEMORY FREE NON PAGED MEMORY SIZE NON PAGED MEMORY USED PARAMETER CHECK DISABLE CHECK ENABLE PLATFORM BITNESS PLATFORM OS TYPE OS LINUX OS RTX OS WINDOWS OS WINDOWS CE PROCESSING COMPENSATION DISABLE COMPENSATION ENABLE TRACE DEFAULT LOG DISABLE LOG ENABLE TRACE ACTIVE NO YES VERSION XORG ACCELERATION THREAD CURRENT 4SIGHTGP FINGERPRINT 4SIGHTX FINGERPRINT ANY FINGERPRINT CONCORD 1394 FINGERPRINT CONCORD GIGE FINGERPRINT CRONOSPLUS FINGERPRINT ID KEY FINGERPRINT IRISGT FINGERPRINT MSERIES FINGERPRINT ORIONHD FINGERPRINT RADIENT FINGERPRINT RADIENTCXP FINGERPRINT SOLIOS FINGERPRINT SUPERSIGHT FINGERPRINT VIO FINGERPRINT