| Customize Help
| Save Settings

MobjInquire



Function Map
Synopsis
Inquire about a MIL object setting or information associated with the MIL object.
Syntax
MIL_INT MobjInquire(
MIL_ID ObjectId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about general settings of a MIL object. You can inquire about read/write properties of a remote MIL object and about information associated with a MIL object. You can also inquire about message mailboxes.

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
ObjectId

Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc()) or any other MIL object, except for MIL objects allocated using MfuncAlloc().

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 [optionally, in C++: a reference to a MIL_STRING]
  • MIL_ID
  • MIL_INT
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MobjInquire() 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 tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

The following InquireType parameter settings can be specified for any MIL objects allocated using an M...Alloc() function.

function map For inquiring about MIL object settings
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_DMIL_PUBLISH

Inquires the MIL object's remote access rights. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_NO

Specifies that the MIL object will not be visible.

Click to summarize M_READ_ONLY

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

Click to summarize M_READ_WRITE

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

Click to summarize M_OBJECT_FILE_EXTENSION +

Inquires the extension of the file from which the object was loaded or restored.

For example, if a file is taken from the file path "C:\Images\Board.mim", this inquire type would return ".mim".

Note that this inquire type returns an empty string if the object was not loaded or restored from a file.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_OBJECT_FILE_FOLDER +

Inquires the folder of the file from which the object was loaded or restored.

For example, if a file is taken from the file path "C:\Images\Board.mim", this inquire type would return "C:\Images".

Note that this inquire type returns an empty string if the object was not loaded or restored from a file.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_OBJECT_FILE_NAME +

Inquires the file name (including the extension) of the file from which the object was loaded or restored.

For example, if a file is taken from the file path "C:\Images\Board.mim", this inquire type would return "Board.mim".

Note that this inquire type returns an empty string if the object was not loaded or restored from a file.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_OBJECT_FILE_NAME_NO_EXTENSION +

Inquires the file name (excluding the extension) of the file from which the object was loaded or restored.

For example, if a file is taken from the file path "C:\Images\Board.mim", this inquire type would return "Board".

Note that this inquire type returns an empty string if the object was not loaded or restored from a file.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_OBJECT_FILE_PATH +

Inquires the whole path of the file from which the object was loaded or restored.

For example, if a file is taken from the file path "C:\Images\Board.mim", this inquire type would return "C:\Images\Board.mim".

Note that this inquire type returns an empty string if the object was not loaded or restored from a file.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_OBJECT_NAME +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_OBJECT_TYPE

Inquires the type of the specified MIL object.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
Click to summarize M_3D_DISPLAY

Specifies a MIL 3D display allocated using M3ddispAlloc().

Click to summarize M_3D_GRAPHIC_LIST

Specifies a MIL 3D graphics list allocated using M3dgraAlloc().

Click to summarize M_3DGEO_GEOMETRY

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

Click to summarize M_3DGEO_TRANSFORMATION_MATRIX

Specifies a MIL 3D transformation matrix object allocated using M3dgeoAlloc() with M_TRANSFORMATION_MATRIX.

Click to summarize M_3DIM_CALCULATE_MAP_SIZE_CONTEXT

Specifies a MIL 3D image processing context that can be used with M3dimCalculateMapSize(), allocated using M3dimAlloc() with M_CALCULATE_MAP_SIZE_CONTEXT.

Click to summarize M_3DIM_FILL_GAPS_CONTEXT

Specifies a MIL 3D image processing context that can be used with M3dimFillGaps(), allocated using M3dimAlloc() with M_FILL_GAPS_CONTEXT.

Click to summarize M_3DIM_MESH_CONTEXT

Specifies a MIL 3D image processing context that can be used with M3dimMesh(), allocated using M3dimAlloc() with M_MESH_CONTEXT.

Click to summarize M_3DIM_NORMALS_CONTEXT

Specifies a MIL 3D image processing context that can be used with M3dimNormals(), allocated using M3dimAlloc() with M_NORMALS_CONTEXT.

Click to summarize M_3DIM_PROFILE_RESULT

Specifies a MIL 3D image processing result buffer for profile results, allocated using M3dimAllocResult() with M_PROFILE_RESULT.

Click to summarize M_3DIM_STATISTICS_CONTEXT

Specifies a MIL 3D image processing context that can be used with M3dimStat(), allocated using M3dimAlloc() with M_STATISTICS_CONTEXT.

Click to summarize M_3DIM_STATISTICS_RESULT

Specifies a MIL 3D image processing result buffer used to store M3dimStat() results, and is allocated using M3dimAllocResult() with M_STATISTICS_RESULT.

Click to summarize M_3DIM_SUBSAMPLE_CONTEXT

Specifies a MIL 3D image processing context that can be used with M3dimSample(), allocated using M3dimAlloc() with M_SUBSAMPLE_CONTEXT.

Click to summarize M_3DIM_SURFACE_SAMPLE_CONTEXT

Specifies a MIL 3D image processing context that can be used with M3dimSample(), allocated using M3dimAlloc() with M_SURFACE_SAMPLE_CONTEXT.

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_DRAW_3D_CONTEXT

Specifies a MIL 3D draw context allocated using M3dmapAlloc() with M_DRAW_3D_CONTEXT.

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_POINT_CLOUD_RESULT

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

Click to summarize M_3DMET_FIT_CONTEXT

Specifies a MIL fit 3D metrology context allocated using M3dmetAlloc() with M_FIT_CONTEXT.

Click to summarize M_3DMET_FIT_RESULT

Specifies a MIL fit 3D metrology result buffer allocated using M3dmetAllocResult() with M_FIT_RESULT.

Click to summarize M_3DMET_STATISTICS_CONTEXT

Specifies a MIL statistics 3D metrology context allocated using M3dmetAlloc() with M_STATISTICS_CONTEXT.

Click to summarize M_3DMET_STATISTICS_RESULT

Specifies a MIL statistics 3D metrology result buffer allocated using M3dmetAllocResult() with M_STATISTICS_RESULT.

Click to summarize M_3DREG_PAIRWISE_REGISTRATION_CONTEXT

Specifies a MIL pairwise 3D registration context allocated using M3dregAlloc() with M_PAIRWISE_REGISTRATION_CONTEXT.

Click to summarize M_3DREG_PAIRWISE_REGISTRATION_RESULT

Specifies a MIL pairwise 3D registration result buffer allocated using M3dregAllocResult() with M_PAIRWISE_REGISTRATION_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_AUGMENTATION_RESULT

Specifies a MIL augmentation result buffer allocated using MimAllocResult() with M_AUGMENTATION_RESULT.

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_DRAW_3D_CONTEXT

Specifies a MIL 3D draw calibration context allocated using McalAlloc() with M_DRAW_3D_CONTEXT.

Click to summarize M_CAL_FIXTURING_OFFSET

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

Click to summarize M_CALL_CONTEXT

Specifies the a MIL function context for a current user-defined function.

Click to summarize M_CLASS_CLASSIFIER_CNN_PREDEFINED_CONTEXT

Specifies a MIL predefined convolutional neural network context allocated using MclassAlloc().

Click to summarize M_CLASS_CLASSIFIER_TREE_ENSEMBLE_CONTEXT

Specifies a MIL tree ensemble classifier context allocated using MclassAlloc().

Click to summarize M_CLASS_DATASET_FEATURES

Specifies a MIL features dataset context allocated using MclassAlloc() with M_DATASET_FEATURES.

Click to summarize M_CLASS_DATASET_IMAGES

Specifies a MIL classification dataset allocated using MclassAlloc().

Click to summarize M_CLASS_PREDICT_CNN_RESULT

Specifies a MIL result buffer to hold the classification results performed with a predefined convolutional neural network context using MclassPredict(). INFO

Click to summarize M_CLASS_PREDICT_TREE_ENSEMBLE_RESULT

Specifies a MIL tree ensemble prediction result buffer, allocated using MclassAllocResult().

Click to summarize M_CLASS_TRAIN_CNN_CONTEXT

Specifies a MIL context to hold the training settings of a convolutional neural network training context allocated using MclassAlloc().

Click to summarize M_CLASS_TRAIN_CNN_RESULT

Specifies a MIL result buffer to hold the result of a call to MclassTrain().

Click to summarize M_CLASS_TRAIN_TREE_ENSEMBLE_CONTEXT

Specifies a MIL tree ensemble training context, allocated using MclassAlloc().

Click to summarize M_CLASS_TRAIN_TREE_ENSEMBLE_RESULT

Specifies a MIL tree ensemble training result buffer, allocated using MclassAlloc().

Click to summarize M_CODE_CONTEXT

Specifies a MIL code context allocated using McolAlloc().

Click to summarize M_CODE_DETECT_RESULT

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

Click to summarize M_CODE_GRADE_RESULT

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

Click to summarize M_CODE_MODEL

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

Click to summarize M_CODE_READ_RESULT

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

Click to summarize M_CODE_TRAIN_RESULT

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

Click to summarize M_CODE_WRITE_RESULT

Specifies a MIL code write 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_CONTAINER

Specifies a MIL container buffer allocated using MbufAllocContainer().

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_DISPLAY

Specifies a MIL display allocated using MdispAlloc().

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 2D graphics context allocated using MgraAlloc().

Click to summarize M_GRAPHIC_LIST

Specifies a MIL 2D 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_HTTP_SERVER

Specifies an HTTP server allocated using MobjAlloc() with M_HTTP_SERVER.

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_CIRCLE_CONTEXT

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

Click to summarize M_MOD_SHAPE_ELLIPSE_CONTEXT

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

Click to summarize M_MOD_SHAPE_RECTANGLE_CONTEXT

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

Click to summarize M_MOD_SHAPE_RESULT

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

Click to summarize M_MOD_SHAPE_SEGMENT_CONTEXT

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

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_DFF_CONTEXT

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

Click to summarize M_REG_DFF_RESULT

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

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_HDR_CONTEXT

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

Click to summarize M_REG_HDR_RESULT

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

Click to summarize M_REG_PHOTOMETRIC_STEREO_CONTEXT

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

Click to summarize M_REG_PHOTOMETRIC_STEREO_RESULT

Specifies a MIL registration result buffer allocated using MregAllocResult() with M_PHOTOMETRIC_STEREO_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_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_SYSTEM_THREAD

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

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.


This value is combined with a 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.


This value is combined with a 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 M_OBJECT_USER_DATA_PTR

Sets the address of the user data to associate with the specified MIL object. This is useful, for example, to associate specific data with the different buffers passed to MdigProcess().

Note that when developing a Distributed MIL controlling application, the address of the user data must be local. In addition, you can only access this data from the local computer. For example, consider a Distributed MIL cluster that consists of two computers (A and B). If on computer A, you associate user data with a remote MIL object, calling MobjInquire with M_OBJECT_USER_DATA_PTR on computer B will return NULL; whereas, on computer A, it will return the address of the user data. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_OWNER_SYSTEM

Inquires the MIL identifier of the system on which the object has been allocated. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

Combination value 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
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)

The following InquireType parameter settings can be specified for a MIL message mailbox object allocated using MobjAlloc() with M_MESSAGE_MAILBOX.

function map For inquiring message mailbox settings
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_INIT_FLAG

Inquires the initialization of the allocated object. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
Click to summarize M_OVERWRITE
//For message mailbox objects

Specifies that only one message can be kept in the mailbox and is replaced at each write. INFO

Click to summarize M_QUEUE
//For message mailbox objects

Specifies that multiple messages can be queued in the mailbox. INFO

Click to summarize M_MESSAGE_COUNT

Inquires the number of messages in the message mailbox.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value >= 0

Specifies the number of messages in the message mailbox.

Click to summarize M_MESSAGE_LENGTH

Inquires the length of the next message in the message mailbox.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value > 0

Specifies the length of the next message in the message mailbox.

Click to summarize M_QUEUE_FULL_MODE

Inquires the behavior of the queue when the message limit is attained. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DEFAULT

Same as M_WRITE_TIMEOUT.

Click to summarize M_ERROR

Specifies that a MIL error is generated when the message limit is attained.

Click to summarize M_WRITE_TIMEOUT

Specifies to wait for the write timeout to elapse.

Click to summarize M_QUEUE_SIZE

Inquires the number of messages the queue can hold. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DEFAULT

Specifies the default value; the default value is 100 messages.

Click to summarize Value > 0

Specifies the number of messages the queue can hold.

Click to summarize M_READ_TIMEOUT

Inquires the amount of time to wait for a read operation. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DEFAULT

Same as M_INFINITE.

Click to summarize M_INFINITE

Specifies that the read operation waits indefinitely.

Click to summarize Value > 0

Specifies the amount of time to wait, in msecs.

Click to summarize M_WRITE_TIMEOUT

Inquires the amount of time to wait for a write operation. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DEFAULT

Same as M_INFINITE.

Click to summarize M_INFINITE

Specifies that the write operation waits indefinitely.

Click to summarize Value > 0

Specifies the amount of time to wait, in msecs.

The following InquireType parameter settings are used to inquire MIL HTTP server objects allocated using MobjAlloc() with M_HTTP_SERVER.

function map For inquiring HTTP server settings
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_HTTP_ADDRESS +

Inquires the web address (URL) with which the MIL HTTP server can be accessed in a web browser.

This setting requires MIL driver update 47 (or later). SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_HTTP_PORT

Inquires the port on which the MIL HTTP server listens for incoming connections.

For increased security, you should ensure that remote computers cannot access this port from the internet/WAN.

This setting requires MIL driver update 47 (or later). SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize 0 <= Value <=66535

Specifies the port number. INFO

Click to summarize M_HTTP_ROOT_DIRECTORY +

Inquires the path to the folder on the local computer in which the files hosted by the MIL HTTP server are stored.

This setting requires MIL driver update 47 (or later). SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_HTTP_STATE

Inquires whether the MIL HTTP server is enabled.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_HTTP_START

Specifies that the MIL HTTP server is enabled.

Click to summarize M_HTTP_STOP

Specifies that the MIL HTTP server is disabled.

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

function map For getting the string size
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_STRING_SIZE

Retrieves the length of the string, including the terminating null character ("\0").

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: 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.
DMIL PUBLISH NO READ ONLY READ WRITE OBJECT FILE EXTENSION OBJECT FILE FOLDER OBJECT FILE NAME OBJECT FILE NAME NO EXTENSION OBJECT FILE PATH OBJECT NAME OBJECT TYPE 3D DISPLAY 3D GRAPHIC LIST 3DGEO GEOMETRY 3DGEO TRANSFORMATION MATRIX 3DIM CALCULATE MAP SIZE CONTEXT 3DIM FILL GAPS CONTEXT 3DIM MESH CONTEXT 3DIM NORMALS CONTEXT 3DIM PROFILE RESULT 3DIM STATISTICS CONTEXT 3DIM STATISTICS RESULT 3DIM SUBSAMPLE CONTEXT 3DIM SURFACE SAMPLE CONTEXT 3DMAP DEPTH CORRECTED DATA 3DMAP DRAW 3D CONTEXT 3DMAP LASER CALIBRATION DATA 3DMAP LASER CONTEXT 3DMAP POINT CLOUD RESULT 3DMET FIT CONTEXT 3DMET FIT RESULT 3DMET STATISTICS CONTEXT 3DMET STATISTICS RESULT 3DREG PAIRWISE REGISTRATION CONTEXT 3DREG PAIRWISE REGISTRATION RESULT APPLICATION ARRAY AUGMENTATION RESULT BEAD CONTEXT BEAD RESULT BLOB CONTEXT BLOB RESULT CAL CONTEXT CAL DRAW 3D CONTEXT CAL FIXTURING OFFSET CALL CONTEXT CLASS CLASSIFIER CNN PREDEFINED CONTEXT CLASS CLASSIFIER TREE ENSEMBLE CONTEXT CLASS DATASET FEATURES CLASS DATASET IMAGES CLASS PREDICT CNN RESULT CLASS PREDICT TREE ENSEMBLE RESULT CLASS TRAIN CNN CONTEXT CLASS TRAIN CNN RESULT CLASS TRAIN TREE ENSEMBLE CONTEXT CLASS TRAIN TREE ENSEMBLE RESULT CODE CONTEXT CODE DETECT RESULT CODE GRADE RESULT CODE MODEL CODE READ RESULT CODE TRAIN RESULT CODE WRITE RESULT COL MATCH CONTEXT COL MATCH RESULT COL RELATIVE CALIBRATION CONTEXT COM CONTEXT CONTAINER COUNT LIST DIGITIZER DISPLAY DMR CONTEXT DMR RESULT EDGE CONTOUR EDGE CREST EDGE RESULT EVENT EVENT LIST EXTREME LIST FIND ORIENTATION LIST GRAPHIC CONTEXT GRAPHIC LIST HIST LIST HTTP SERVER 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 CIRCLE CONTEXT MOD SHAPE ELLIPSE CONTEXT MOD SHAPE RECTANGLE CONTEXT MOD SHAPE RESULT MOD SHAPE SEGMENT CONTEXT MUTEX OCR FONT OCR RESULT PAT CONTEXT PAT RESULT PROJ LIST REG DFF CONTEXT REG DFF RESULT REG EDOF CONTEXT REG EDOF RESULT REG HDR CONTEXT REG HDR RESULT REG PHOTOMETRIC STEREO CONTEXT REG PHOTOMETRIC STEREO RESULT REG STITCHING CONTEXT REG STITCHING RESULT SELECTABLE THREAD SEQUENCE CONTEXT STATISTICS RESULT STR CONTEXT STR RESULT STRUCT ELEMENT SYS IO CONTEXT SYSTEM SYSTEM THREAD THREAD USER OBJECT 1 USER OBJECT 2 WAVELET TRANSFORM RESULT OBJECT USER DATA PTR OWNER SYSTEM DEFAULT HOST INIT FLAG OVERWRITE QUEUE MESSAGE COUNT MESSAGE LENGTH QUEUE FULL MODE DEFAULT ERROR WRITE TIMEOUT QUEUE SIZE DEFAULT READ TIMEOUT DEFAULT INFINITE WRITE TIMEOUT DEFAULT INFINITE HTTP ADDRESS HTTP PORT HTTP ROOT DIRECTORY HTTP STATE HTTP START HTTP STOP STRING SIZE