| MIL 10 Reference
| Customize Help
| Save Settings

MappInquireObject


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MappInquireMp
MappOpenConnection
Synopsis
Inquire about a MIL object setting in a Distributed MIL publishing application.
Syntax
MIL_INT MappInquireObject(
MIL_ID ContextAppId, //in
MIL_ID ObjectId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about general MIL object settings in a publishing application within the Distributed MIL monitoring configuration.

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.

Typically specifying an application context identifier is used to specify a remote application on a remote computer. However, it can be used for a remote application on the local computer, or the current application. When you explicitly specify the current application, it is equivalent to specifying M_DEFAULT.

(summarize)
ObjectId

Specifies the identifier of the MIL object about which to inquire.

InquireType

Specifies the MIL object setting 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
  • MIL_INT
  • MIL_INT64

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 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 inquiring about MIL object settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_DMIL_PUBLISH

Inquires the MIL object's remote access rights. SET

(summarize)
Collapse M_NO

Specifies that the MIL object will not be visible.
Collapse M_READ_ONLY

Specifies that the MIL object can only be used as a source or to be inquired. INFO
Collapse M_READ_WRITE

Specifies that the MIL object can be used as a destination or can be controlled by MIL functions. INFO
Collapse M_OBJECT_NAME

Inquires the MIL object's user-defined name. SET

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_TEXT_CHAR
Array size: Inquired with M_OBJECT_NAME_SIZE.

Collapse M_OBJECT_NAME_SIZE

Inquires the number of characters in the MIL object's user-defined name.

(summarize)
Collapse M_OBJECT_TYPE

Inquires the type of the specified MIL object.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT64

Collapse M_3DMAP_ALIGNMENT_RESULT

Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_ALIGNMENT_RESULT.
Collapse M_3DMAP_DEPTH_CORRECTED_DATA

Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_DEPTH_CORRECTED_DATA.
Collapse M_3DMAP_GEOMETRY

Specifies a MIL 3D geometry object allocated using M3dmapAlloc() with M_GEOMETRY.
Collapse M_3DMAP_LASER_CALIBRATION_DATA

Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_LASER_CALIBRATION_DATA.
Collapse M_3DMAP_LASER_CONTEXT

Specifies a MIL 3D reconstruction context allocated using M3dmapAlloc() with M_LASER.
Collapse M_3DMAP_PAIRWISE_ALIGNMENT_CONTEXT

Specifies a MIL pairwise 3D alignment context allocated using M3dmapAlloc() with M_PAIRWISE_ALIGNMENT_CONTEXT.
Collapse M_3DMAP_POINT_CLOUD_CONTAINER

Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_POINT_CLOUD_CONTAINER.
Collapse M_3DMAP_STAT_RESULT

Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_STAT_RESULT.
Collapse M_APPLICATION

Specifies a MIL application context allocated using MappAlloc().
Collapse M_ARRAY

Specifies a MIL array buffer allocated using MbufAlloc2d() with M_ARRAY.
Collapse M_BEAD_CONTEXT

Specifies a MIL bead context allocated using MbeadAlloc().
Collapse M_BEAD_RESULT

Specifies a MIL bead result buffer allocated using MbeadAllocResult().
Collapse M_BLOB_FEATURE_LIST

Specifies a MIL blob analysis feature list allocated using MblobAllocFeatureList().
Collapse M_BLOB_RESULT

Specifies a MIL blob analysis result buffer allocated using MblobAllocResult().
Collapse M_CAL_CONTEXT

Specifies a MIL calibration context allocated using McalAlloc().
Collapse M_CAL_FIXTURING_OFFSET

Specifies a MIL fixturing offset object allocated using McalAlloc() with M_FIXTURING_OFFSET.
Collapse M_CODE_CONTEXT

Specifies a MIL code context allocated using McolAlloc().
Collapse M_CODE_MODEL

Specifies a MIL code model allocated using McodeModel() with M_ADD.
Collapse M_CODE_RESULT

Specifies a MIL code result buffer allocated using McodeAllocResult().
Collapse M_COL_MATCH_CONTEXT

Specifies a MIL color analysis context (for matching) allocated using McolAlloc() with M_COLOR_MATCHING.
Collapse M_COL_MATCH_RESULT

Specifies a MIL color analysis result buffer (for matching) allocated using McolAllocResult() with M_COLOR_MATCHING_RESULT.
Collapse M_COL_RELATIVE_CALIBRATION_CONTEXT

Specifies a MIL relative color calibration context allocated using McolAlloc() with M_COLOR_CALIBRATION_RELATIVE.
Collapse M_COUNT_LIST

Specifies a MIL count list result buffer allocated using MimAllocResult() with M_COUNT_LIST.
Collapse M_DIGITIZER

Specifies a MIL digitizer allocated using MdigAlloc().
Collapse M_DISPLAY

Specifies a MIL display allocated using MdispAlloc().
Collapse M_EDGE_CONTOUR

Specifies a MIL edge contour context allocated using MedgeAlloc() with M_CONTOUR.
Collapse M_EDGE_CREST

Specifies a MIL edge crest context allocated using MedgeAlloc() with M_CREST.
Collapse M_EDGE_RESULT

Specifies a MIL edge result buffer allocated using MedgeAllocResult().
Collapse M_EVENT

Specifies a MIL event allocated using MthrAlloc() with M_EVENT.
Collapse M_EVENT_LIST

Specifies a MIL event list result buffer allocated using MimAllocResult() with M_EVENT_LIST.
Collapse M_EXTREME_LIST

Specifies a MIL extreme list result buffer allocated using MimAllocResult() with M_EXTREME_LIST.
Collapse M_FIND_ORIENTATION_LIST

Specifies a MIL find orientation list result buffer allocated using MimAllocResult() with M_FIND_ORIENTATION_LIST.
Collapse M_GRAPHIC_CONTEXT

Specifies a MIL graphics context allocated using MgraAlloc().
Collapse M_GRAPHIC_LIST

Specifies a MIL graphics list allocated using MgraAllocList().
Collapse M_HIST_LIST

Specifies a MIL histogram list result buffer allocated using MimAllocResult() with M_HIST_LIST.
Collapse M_IM_CONTEXT

Specifies a MIL image processing context allocated using MimAlloc().
Collapse M_IMAGE

Specifies a MIL image buffer allocated using MbufAllocColor() with M_IMAGE.
Collapse M_KERNEL

Specifies a MIL kernel buffer allocated using MbufAlloc2d() with M_KERNEL.
Collapse M_LOCATE_PEAK_1D_RESULT

Specifies a MIL locate 1D peak result buffer allocated using MimAllocResult() with M_LOCATE_PEAK_1D_RESULT.
Collapse M_LUT

Specifies a MIL LUT buffer allocated using MbufAlloc2d() with M_LUT.
Collapse M_MEAS_CONTEXT

Specifies a MIL measurement context allocated using MmeasAllocContext().
Collapse M_MEAS_MARKER

Specifies a MIL measurement marker allocated using MmeasAllocMarker().
Collapse M_MEAS_RESULT

Specifies a MIL measurement result buffer allocated using MmeasAllocResult().
Collapse M_MET_CONTEXT

Specifies a MIL metrology context allocated using MmetAlloc() with M_CONTEXT.
Collapse M_MET_DERIVED_GEOMETRY_REGION

Specifies a MIL metrology derived geometry region object allocated using MmetAlloc() with M_DERIVED_GEOMETRY_REGION.
Collapse M_MET_RESULT

Specifies a MIL metrology result buffer allocated using MmetAllocResult().
Collapse M_MOD_GEOMETRIC

Specifies a MIL Model Finder context allocated using MmodAlloc() with M_GEOMETRIC.
Collapse M_MOD_GEOMETRIC_CONTROLLED

Specifies a MIL Model Finder context allocated using MmodAlloc() with M_GEOMETRIC_CONTROLLED.
Collapse M_MOD_RESULT

Specifies a MIL Model Finder result buffer allocated using MmodAllocResult() with M_DEFAULT.
Collapse M_MOD_SHAPE_RESULT

Specifies a MIL Model Finder result buffer allocated using MmodAllocResult() with M_SHAPE_CIRCLE.
Collapse M_MUTEX

Specifies a MIL mutex allocated using MthrAlloc() with M_MUTEX.
Collapse M_OCR_FONT

Specifies a MIL character recognition font context allocated using MocrAllocFont().
Collapse M_OCR_RESULT

Specifies a MIL character recognition result buffer allocated using MocrAllocResult().
Collapse M_PAT_MODEL

Specifies a MIL pattern matching model allocated using MpatAllocModel().
Collapse M_PAT_RESULT

Specifies a MIL pattern matching result buffer allocated using MpatAllocResult().
Collapse M_PROJ_LIST

Specifies a MIL project list result buffer allocated using MimAllocResult() with M_PROJ_LIST.
Collapse M_REG_EDOF_CONTEXT

Specifies a MIL registration context allocated using MregAlloc() with M_EXTENDED_DEPTH_OF_FIELD.
Collapse M_REG_EDOF_RESULT

Specifies a MIL registration result buffer allocated using MregAllocResult() with M_EXTENDED_DEPTH_OF_FIELD_RESULT.
Collapse M_REG_STITCHING_CONTEXT

Specifies a MIL registration context allocated using MregAlloc() with M_STITCHING.
Collapse M_REG_STITCHING_RESULT

Specifies a MIL registration result buffer allocated using MregAllocResult() with M_STITCHING_RESULT.
Collapse M_SELECTABLE_THREAD

Specifies a MIL selectable thread allocated using MthrAlloc() with M_SELECTABLE_THREAD.
Collapse M_SEQUENCE_CONTEXT

Specifies a MIL sequence context allocated using MseqAlloc().
Collapse M_SHAPE_CIRCLE

Specifies a MIL Model Finder context allocated using MmodAlloc() with M_SHAPE_CIRCLE.
Collapse M_STAT_LIST

Specifies a MIL MimStat() result buffer allocated using MimAllocResult() with M_STAT_LIST.
Collapse M_STAT_MULTIPLE_RESULT

Specifies a MIL MimStatMultiple() result buffer allocated using MimAllocResult() with M_STAT_MULTIPLE_RESULT.
Collapse M_STR_CONTEXT

Specifies a MIL string context allocated using MstrAlloc().
Collapse M_STR_RESULT

Specifies a MIL string result buffer allocated using MstrAllocResult().
Collapse M_STRUCT_ELEMENT

Specifies a MIL structuring element buffer allocated using MbufAlloc2d() with M_STRUCT_ELEMENT.
Collapse M_SYS_IO_CONTEXT

Specifies a MIL system I/O context allocated using MsysIoAlloc().
Collapse M_SYSTEM

Specifies a MIL system context allocated using MsysAlloc().
Collapse M_THREAD

Specifies a MIL thread context object allocated using MthrAlloc() with M_THREAD.
Collapse M_USER_OBJECT_1 +

Specifies a MIL object from group one of the user-defined object types allocated using MfuncAllocId() with M_USER_OBJECT_1.


This value is combined with a value from the following table:
(summarize)
Collapse M_USER_OBJECT_2 +

Specifies a MIL object from group two of the user-defined object types allocated using MfuncAllocId() with M_USER_OBJECT_2.


This value is combined with a value from the following table:
(summarize)
Collapse M_WAVELET_TRANSFORM_RESULT

Specifies a MIL wavelet transform result buffer allocated using MimAllocResult() with M_WAVELET_TRANSFORM_RESULT.
Combination constant for M_USER_OBJECT_1 (when InquireType=M_OBJECT_TYPE and UserVarPtr=M_USER_OBJECT_1); M_USER_OBJECT_2 (when InquireType=M_OBJECT_TYPE and UserVarPtr=M_USER_OBJECT_2).

The following value is combined with the above-mentioned values to set the offset.

The offset allows you to distinguish between the different object types of the same group (for example, M_USER_OBJECT_1 + 0x0001).

function map For distinguishing between the different object types
CollapseCombination value Description
Collapse Value

Specifies the offset within the selected object type group. The value must have only one of its 16 least significant bits set.

(summarize)
Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information is not a single value, this function will return M_NULL.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
DEFAULT DMIL PUBLISH NO READ ONLY READ WRITE OBJECT NAME OBJECT NAME SIZE OBJECT TYPE 3DMAP ALIGNMENT RESULT 3DMAP DEPTH CORRECTED DATA 3DMAP GEOMETRY 3DMAP LASER CALIBRATION DATA 3DMAP LASER CONTEXT 3DMAP PAIRWISE ALIGNMENT CONTEXT 3DMAP POINT CLOUD CONTAINER 3DMAP STAT RESULT APPLICATION ARRAY BEAD CONTEXT BEAD RESULT BLOB FEATURE LIST BLOB RESULT CAL CONTEXT CAL FIXTURING OFFSET CODE CONTEXT CODE MODEL CODE RESULT COL MATCH CONTEXT COL MATCH RESULT COL RELATIVE CALIBRATION CONTEXT COUNT LIST DIGITIZER DISPLAY EDGE CONTOUR EDGE CREST EDGE RESULT EVENT EVENT LIST EXTREME LIST FIND ORIENTATION LIST GRAPHIC CONTEXT GRAPHIC LIST HIST LIST IM CONTEXT IMAGE KERNEL LOCATE PEAK 1D RESULT LUT MEAS CONTEXT MEAS MARKER MEAS RESULT MET CONTEXT MET DERIVED GEOMETRY REGION MET RESULT MOD GEOMETRIC MOD GEOMETRIC CONTROLLED MOD RESULT MOD SHAPE RESULT MUTEX OCR FONT OCR RESULT PAT MODEL PAT RESULT PROJ LIST REG EDOF CONTEXT REG EDOF RESULT REG STITCHING CONTEXT REG STITCHING RESULT SELECTABLE THREAD SEQUENCE CONTEXT SHAPE CIRCLE STAT LIST STAT MULTIPLE RESULT STR CONTEXT STR RESULT STRUCT ELEMENT SYS IO CONTEXT SYSTEM THREAD USER OBJECT 1 USER OBJECT 2 WAVELET TRANSFORM RESULT