Click here to show toolbars of the Web Online Help System: show toolbars
 

| Customize Help
| Save Settings

MappInquireConnection



Function Map
Synopsis
Inquire about published MIL objects on a Distributed MIL publishing application.
Syntax
MIL_INT MappInquireConnection(
MIL_ID ContextAppId, //in
MIL_INT64 InquireType, //in
MIL_INT64 ControlFlag, //in
MIL_INT64 ExtraFlag, //in
void *UserVarPtr //out
)
Description

This function inquires about the published MIL objects on a Distributed MIL publishing application. A monitoring application will use this function to generate a list of the published MIL objects on a publishing application. With this list, you can determine the MIL identifier of a specific MIL object. With this MIL identifier, you can perform any MIL operations on the MIL object that its permission level allows.

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
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the current application context.

Click to summarize 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)
InquireType

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

Note that display objects cannot be published, and so do not appear as a possible return value.

See the Parameter associations section for possible values that can be specified.

ControlFlag

Specifies an attribute of the inquire operation to perform.

If this parameter is not required for the inquire operation, it must be set to M_DEFAULT.

See the Parameter associations section for possible values that can be specified.

ExtraFlag

Specifies an attribute of the inquire operation to perform.

If this parameter is not required for the inquire operation, it must be set to M_DEFAULT.

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_ID
  • MIL_ID
  • MIL_INT64

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

The table below lists possible values for the InquireType, ControlFlag, and ExtraFlag parameters and possible values returned to the UserVarPtr parameter.

Set unused parameters to M_DEFAULT.

function map For inquiring about a DMIL monitoring configuration connection
Click to summarizeInquireType Description
ControlFlag
ExtraFlag
UserVarPtr
- Possible values returned
Click to summarize M_DMIL_PUBLISHED_LIST

Inquires the list of MIL identifiers associated with the published MIL objects in a Distributed MIL publishing application.

Published MIL objects are those MIL objects set to read or read/write.

(summarize)
Click to summarize ControlFlag

Specifies to limit the returned list from all MIL objects to all MIL objects of the specified MIL object type.

Note that a display object cannot be published, and so is not a possible object type with which to limit the returned list.

(summarize)
Click to summarize M_DEFAULT

Specifies to include all MIL object types in the Distributed MIL publishing application.

Click to summarize M_3DMAP_ALIGNMENT_RESULT

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

Click to summarize M_3DMAP_DEPTH_CORRECTED_DATA

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

Click to summarize M_3DMAP_GEOMETRY

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

Click to summarize M_3DMAP_LASER_CALIBRATION_DATA

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

Click to summarize M_3DMAP_LASER_CONTEXT

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

Click to summarize M_3DMAP_PAIRWISE_ALIGNMENT_CONTEXT

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

Click to summarize M_3DMAP_POINT_CLOUD_CONTAINER

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

Click to summarize M_3DMAP_STAT_RESULT

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

Click to summarize M_APPLICATION

Specifies a MIL application context allocated using MappAlloc().

Click to summarize M_ARRAY

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

Click to summarize M_BEAD_CONTEXT

Specifies a MIL bead context allocated using MbeadAlloc().

Click to summarize M_BEAD_RESULT

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

Click to summarize M_BLOB_CONTEXT

Specifies a MIL blob analysis context allocated using MblobAlloc().

Click to summarize M_BLOB_RESULT

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

Click to summarize M_CAL_CONTEXT

Specifies a MIL camera calibration context allocated using McalAlloc().

Click to summarize M_CAL_FIXTURING_OFFSET

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

Click to summarize M_CODE_CONTEXT

Specifies a MIL code context allocated using McolAlloc().

Click to summarize M_CODE_MODEL

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

Click to summarize M_CODE_RESULT

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

Click to summarize M_COL_MATCH_CONTEXT

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

Click to summarize M_COL_MATCH_RESULT

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

Click to summarize M_COL_RELATIVE_CALIBRATION_CONTEXT

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

Click to summarize M_COM_CONTEXT

Specifies a MIL industrial communication context allocated using McomAlloc().

Click to summarize M_COUNT_LIST

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

Click to summarize M_DIGITIZER

Specifies a MIL digitizer allocated using MdigAlloc().

Click to summarize M_DMR_CONTEXT

Specifies a MIL SureDotOCR context allocated using MdmrAlloc().

Click to summarize M_DMR_RESULT

Specifies a MIL SureDotOCR result buffer allocated using MdmrAllocResult().

Click to summarize M_EDGE_CONTOUR

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

Click to summarize M_EDGE_CREST

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

Click to summarize M_EDGE_RESULT

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

Click to summarize M_EVENT

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

Click to summarize M_EVENT_LIST

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

Click to summarize M_EXTREME_LIST

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

Click to summarize M_FIND_ORIENTATION_LIST

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

Click to summarize M_GRAPHIC_CONTEXT

Specifies a MIL graphics context allocated using MgraAlloc().

Click to summarize M_GRAPHIC_LIST

Specifies a MIL graphics list allocated using MgraAllocList().

Click to summarize M_HIST_LIST

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

Click to summarize M_IM_CONTEXT

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

Click to summarize M_IMAGE

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

Click to summarize M_KERNEL

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

Click to summarize M_LOCATE_PEAK_1D_RESULT

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

Click to summarize M_LUT

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

Click to summarize M_MEAS_CONTEXT

Specifies a MIL measurement context allocated using MmeasAllocContext().

Click to summarize M_MEAS_MARKER

Specifies a MIL measurement marker allocated using MmeasAllocMarker().

Click to summarize M_MEAS_RESULT

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

Click to summarize M_MESSAGE_MAILBOX

Specifies a MIL message mailbox allocated using MobjAlloc().

Click to summarize M_MET_CONTEXT

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

Click to summarize M_MET_DERIVED_GEOMETRY_REGION

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

Click to summarize M_MET_RESULT

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

Click to summarize M_MOD_GEOMETRIC

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

Click to summarize M_MOD_GEOMETRIC_CONTROLLED

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

Click to summarize M_MOD_RESULT

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

Click to summarize M_MOD_SHAPE_RESULT

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

Click to summarize M_MUTEX

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

Click to summarize M_OCR_FONT

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

Click to summarize M_OCR_RESULT

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

Click to summarize M_PAT_CONTEXT

Specifies a MIL pattern matching context allocated using MpatAlloc().

Click to summarize M_PAT_RESULT

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

Click to summarize M_PROJ_LIST

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

Click to summarize M_REG_EDOF_CONTEXT

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

Click to summarize M_REG_EDOF_RESULT

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

Click to summarize M_REG_STITCHING_CONTEXT

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

Click to summarize M_REG_STITCHING_RESULT

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

Click to summarize M_SELECTABLE_THREAD

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

Click to summarize M_SEQUENCE_CONTEXT

Specifies a MIL sequence context allocated using MseqAlloc().

Click to summarize M_SHAPE_CIRCLE

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

Click to summarize M_STATISTICS_RESULT

Specifies a MIL MimStatCalculate() result buffer allocated using MimAllocResult() with M_STATISTICS_RESULT.

Click to summarize M_STR_CONTEXT

Specifies a MIL string context allocated using MstrAlloc().

Click to summarize M_STR_RESULT

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

Click to summarize M_STRUCT_ELEMENT

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

Click to summarize M_SYS_IO_CONTEXT

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

Click to summarize M_SYSTEM

Specifies a MIL system context allocated using MsysAlloc().

Click to summarize M_THREAD

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

Click to summarize 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.


You must specify a combination value from the following table:
(summarize)
Click to summarize 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.


You must specify a combination value from the following table:
(summarize)
Click to summarize M_WAVELET_TRANSFORM_RESULT

Specifies a MIL wavelet transform result buffer allocated using MimAllocResult() with M_WAVELET_TRANSFORM_RESULT.

Click to summarize ExtraFlag

Specifies the size of the array.

If the current list of published MIL objects in the publishing application is smaller than the array size, the array will be populated with the MIL identifiers associated with all the MIL objects in the list, and the remaining elements will be populated with M_NULL.

If the current list of published MIL objects in the publishing application is larger than the array size, the array will be populated with the MIL identifiers associated with the first MIL objects it receives, and the remaining MIL identifiers on the list will be ignored.

(summarize)
Click to summarize UserVarPtr
Data type info: Data type: array of type MIL_ID (more details...)
Click to summarize M_DMIL_PUBLISHED_LIST_SIZE

Inquires the current number of MIL objects published in a Distributed MIL publishing application.

(summarize)
Click to summarize ControlFlag

Specifies to limit the count from all MIL objects to all MIL objects of the specified MIL object type.

Note that a display object cannot be published, and so is not a possible object type with which to limit the size of returned list.

(summarize)
Click to summarize M_DEFAULT

Specifies to count all MIL object types in the Distributed MIL publishing application.

Click to summarize M_3DMAP_ALIGNMENT_RESULT

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

Click to summarize M_3DMAP_DEPTH_CORRECTED_DATA

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

Click to summarize M_3DMAP_GEOMETRY

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

Click to summarize M_3DMAP_LASER_CALIBRATION_DATA

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

Click to summarize M_3DMAP_LASER_CONTEXT

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

Click to summarize M_3DMAP_PAIRWISE_ALIGNMENT_CONTEXT

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

Click to summarize M_3DMAP_POINT_CLOUD_CONTAINER

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

Click to summarize M_3DMAP_STAT_RESULT

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

Click to summarize M_APPLICATION

Specifies a MIL application context allocated using MappAlloc().

Click to summarize M_ARRAY

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

Click to summarize M_BEAD_CONTEXT

Specifies a MIL bead context allocated using MbeadAlloc().

Click to summarize M_BEAD_RESULT

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

Click to summarize M_BLOB_CONTEXT

Specifies a MIL blob analysis context allocated using MblobAlloc().

Click to summarize M_BLOB_RESULT

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

Click to summarize M_CAL_CONTEXT

Specifies a MIL camera calibration context allocated using McalAlloc().

Click to summarize M_CAL_FIXTURING_OFFSET

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

Click to summarize M_CODE_CONTEXT

Specifies a MIL code context allocated using McolAlloc().

Click to summarize M_CODE_MODEL

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

Click to summarize M_CODE_RESULT

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

Click to summarize M_COL_MATCH_CONTEXT

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

Click to summarize M_COL_MATCH_RESULT

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

Click to summarize M_COL_RELATIVE_CALIBRATION_CONTEXT

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

Click to summarize M_COM_CONTEXT

Specifies a MIL industrial communication context allocated using McomAlloc().

Click to summarize M_COUNT_LIST

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

Click to summarize M_DIGITIZER

Specifies a MIL digitizer allocated using MdigAlloc().

Click to summarize M_DMR_CONTEXT

Specifies a MIL SureDotOCR context allocated using MdmrAlloc().

Click to summarize M_DMR_RESULT

Specifies a MIL SureDotOCR result buffer allocated using MdmrAllocResult().

Click to summarize M_EDGE_CONTOUR

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

Click to summarize M_EDGE_CREST

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

Click to summarize M_EDGE_RESULT

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

Click to summarize M_EVENT

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

Click to summarize M_EVENT_LIST

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

Click to summarize M_EXTREME_LIST

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

Click to summarize M_FIND_ORIENTATION_LIST

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

Click to summarize M_GRAPHIC_CONTEXT

Specifies a MIL graphics context allocated using MgraAlloc().

Click to summarize M_GRAPHIC_LIST

Specifies a MIL graphics list allocated using MgraAllocList().

Click to summarize M_HIST_LIST

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

Click to summarize M_IM_CONTEXT

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

Click to summarize M_IMAGE

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

Click to summarize M_KERNEL

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

Click to summarize M_LOCATE_PEAK_1D_RESULT

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

Click to summarize M_LUT

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

Click to summarize M_MEAS_CONTEXT

Specifies a MIL measurement context allocated using MmeasAllocContext().

Click to summarize M_MEAS_MARKER

Specifies a MIL measurement marker allocated using MmeasAllocMarker().

Click to summarize M_MEAS_RESULT

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

Click to summarize M_MESSAGE_MAILBOX

Specifies a MIL message mailbox allocated using MobjAlloc().

Click to summarize M_MET_CONTEXT

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

Click to summarize M_MET_DERIVED_GEOMETRY_REGION

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

Click to summarize M_MET_RESULT

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

Click to summarize M_MOD_GEOMETRIC

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

Click to summarize M_MOD_GEOMETRIC_CONTROLLED

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

Click to summarize M_MOD_RESULT

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

Click to summarize M_MOD_SHAPE_RESULT

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

Click to summarize M_MUTEX

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

Click to summarize M_OCR_FONT

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

Click to summarize M_OCR_RESULT

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

Click to summarize M_PAT_CONTEXT

Specifies a MIL pattern matching context allocated using MpatAlloc().

Click to summarize M_PAT_RESULT

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

Click to summarize M_PROJ_LIST

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

Click to summarize M_REG_EDOF_CONTEXT

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

Click to summarize M_REG_EDOF_RESULT

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

Click to summarize M_REG_STITCHING_CONTEXT

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

Click to summarize M_REG_STITCHING_RESULT

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

Click to summarize M_SELECTABLE_THREAD

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

Click to summarize M_SEQUENCE_CONTEXT

Specifies a MIL sequence context allocated using MseqAlloc().

Click to summarize M_SHAPE_CIRCLE

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

Click to summarize M_STATISTICS_RESULT

Specifies a MIL MimStatCalculate() result buffer allocated using MimAllocResult() with M_STATISTICS_RESULT.

Click to summarize M_STR_CONTEXT

Specifies a MIL string context allocated using MstrAlloc().

Click to summarize M_STR_RESULT

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

Click to summarize M_STRUCT_ELEMENT

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

Click to summarize M_SYS_IO_CONTEXT

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

Click to summarize M_SYSTEM

Specifies a MIL system context allocated using MsysAlloc().

Click to summarize M_THREAD

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

Click to summarize 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.


You must specify a combination value from the following table:
(summarize)
Click to summarize 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.


You must specify a combination value from the following table:
(summarize)
Click to summarize M_WAVELET_TRANSFORM_RESULT

Specifies a MIL wavelet transform result buffer allocated using MimAllocResult() with M_WAVELET_TRANSFORM_RESULT.

Click to summarize UserVarPtr
Data type info: Data type: address of a MIL_INT64
Click to summarize M_DMIL_PUBLISHED_NAME

Inquires the MIL object's MIL identifier from the MIL object's name.

(summarize)
Click to summarize ControlFlag

Specifies the following.

(summarize)
Click to summarize
M_PTR_TO_MIL_INT(
MIL_CONST_TEXT_PTR * String
)

Casts the address of the string identifying the MIL object, from a MIL_CONST_TEXT_PTR to a MIL_INT.

(summarize)
Parameters

This parameter specifies the string whose address to cast.

MIL_TEXT("ObjectName") 1

Specifies the name of the MIL object.

Click to summarize UserVarPtr
Data type info: Data type: address of a MIL_ID

1 If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Combination value for M_USER_OBJECT_1 (when InquireType=M_DMIL_PUBLISHED_LIST and ControlFlag=M_USER_OBJECT_1); M_USER_OBJECT_1 (when InquireType=M_DMIL_PUBLISHED_LIST_SIZE and ControlFlag=M_USER_OBJECT_1); M_USER_OBJECT_2 (when InquireType=M_DMIL_PUBLISHED_LIST and ControlFlag=M_USER_OBJECT_2); M_USER_OBJECT_2 (when InquireType=M_DMIL_PUBLISHED_LIST_SIZE and ControlFlag=M_USER_OBJECT_2).

You must add the following value to 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
Click to summarizeCombination value Description
Click to summarize 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 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.
DEFAULT DMIL PUBLISHED LIST DEFAULT 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 CONTEXT BLOB RESULT CAL CONTEXT CAL FIXTURING OFFSET CODE CONTEXT CODE MODEL CODE RESULT COL MATCH CONTEXT COL MATCH RESULT COL RELATIVE CALIBRATION CONTEXT COM CONTEXT COUNT LIST DIGITIZER DMR CONTEXT DMR RESULT 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 MESSAGE MAILBOX MET CONTEXT MET DERIVED GEOMETRY REGION MET RESULT MOD GEOMETRIC MOD GEOMETRIC CONTROLLED MOD RESULT MOD SHAPE RESULT MUTEX OCR FONT OCR RESULT PAT CONTEXT PAT RESULT PROJ LIST REG EDOF CONTEXT REG EDOF RESULT REG STITCHING CONTEXT REG STITCHING RESULT SELECTABLE THREAD SEQUENCE CONTEXT SHAPE CIRCLE STATISTICS RESULT STR CONTEXT STR RESULT STRUCT ELEMENT SYS IO CONTEXT SYSTEM THREAD USER OBJECT 1 USER OBJECT 2 WAVELET TRANSFORM RESULT DMIL PUBLISHED LIST SIZE DEFAULT 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 CONTEXT BLOB RESULT CAL CONTEXT CAL FIXTURING OFFSET CODE CONTEXT CODE MODEL CODE RESULT COL MATCH CONTEXT COL MATCH RESULT COL RELATIVE CALIBRATION CONTEXT COM CONTEXT COUNT LIST DIGITIZER DMR CONTEXT DMR RESULT 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 MESSAGE MAILBOX MET CONTEXT MET DERIVED GEOMETRY REGION MET RESULT MOD GEOMETRIC MOD GEOMETRIC CONTROLLED MOD RESULT MOD SHAPE RESULT MUTEX OCR FONT OCR RESULT PAT CONTEXT PAT RESULT PROJ LIST REG EDOF CONTEXT REG EDOF RESULT REG STITCHING CONTEXT REG STITCHING RESULT SELECTABLE THREAD SEQUENCE CONTEXT SHAPE CIRCLE STATISTICS RESULT STR CONTEXT STR RESULT STRUCT ELEMENT SYS IO CONTEXT SYSTEM THREAD USER OBJECT 1 USER OBJECT 2 WAVELET TRANSFORM RESULT DMIL PUBLISHED NAME