MobjInquire

Filters
See also

User Guide:

Associating a MIL identifier with a user-defined object Message mailboxes Monitoring configuration

Reference:

MbufAlloc2d MfuncAlloc MfuncAllocId MfuncParam MobjAlloc MobjControl

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/GPm

Available on Matrox Supersight

Function map

Examples

mil3dcam_pfocus.cpp
mil3dcam_sickrangerc.cpp
mil3dcam_sickrangere.cpp

Function Map

- ObjectId

Parameter Associations

Table:	For inquiring about MIL object settings
+ combination:	For distinguishing between the different object types
Table:	For inquiring message mailbox settings

Return value

Compilation information

Synopsis

Inquire about a MIL object setting in a Distributed MIL publishing application.

Syntax

MIL_INT MobjInquire(

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

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
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.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

For inquiring about MIL object settings
For inquiring message mailbox settings

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

For inquiring about MIL object settings
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_DMIL_PUBLISH		Inquires the MIL object's remote access rights. SET (summarize) Inquires the MIL object's remote access rights. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	M_NO	Specifies that the MIL object will not be visible.
	M_READ_ONLY	Specifies that the MIL object can only be used as a source or to be inquired. INFO
	M_READ_WRITE	Specifies that the MIL object can be used as a destination or can be controlled by MIL functions. INFO
M_OBJECT_NAME		Inquires the MIL object's user-defined name. SET (summarize) Inquires the MIL object's user-defined name. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: array of type MIL_TEXT_CHAR (more details...) Data type: array of type MIL_TEXT_CHAR Required array size: MobjInquire() with M_OBJECT_NAME_SIZE Data type info: Data type: array of type MIL_TEXT_CHAR (more details...) Data type: array of type MIL_TEXT_CHAR Required array size: MobjInquire() with M_OBJECT_NAME_SIZE
M_OBJECT_NAME_SIZE		Inquires the number of characters in the MIL object's user-defined name. (summarize) Inquires the number of characters in the MIL object's user-defined name. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
M_OBJECT_TYPE		Inquires the type of the specified MIL object. (summarize) Inquires the type of the specified MIL object. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT64 Data type info: Data type: address of a MIL_INT64
	M_3DMAP_ALIGNMENT_RESULT	Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_ALIGNMENT_RESULT.
	M_3DMAP_DEPTH_CORRECTED_DATA	Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_DEPTH_CORRECTED_DATA.
	M_3DMAP_GEOMETRY	Specifies a MIL 3D geometry object allocated using M3dmapAlloc() with M_GEOMETRY.
	M_3DMAP_LASER_CALIBRATION_DATA	Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_LASER_CALIBRATION_DATA.
	M_3DMAP_LASER_CONTEXT	Specifies a MIL 3D reconstruction context allocated using M3dmapAlloc() with M_LASER.
	M_3DMAP_PAIRWISE_ALIGNMENT_CONTEXT	Specifies a MIL pairwise 3D alignment context allocated using M3dmapAlloc() with M_PAIRWISE_ALIGNMENT_CONTEXT.
	M_3DMAP_POINT_CLOUD_CONTAINER	Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_POINT_CLOUD_CONTAINER.
	M_3DMAP_STAT_RESULT	Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_STAT_RESULT.
	M_APPLICATION	Specifies a MIL application context allocated using MappAlloc().
	M_ARRAY	Specifies a MIL array buffer allocated using MbufAlloc2d() with M_ARRAY.
	M_BEAD_CONTEXT	Specifies a MIL bead context allocated using MbeadAlloc().
	M_BEAD_RESULT	Specifies a MIL bead result buffer allocated using MbeadAllocResult().
	M_BLOB_CONTEXT	Specifies a MIL blob analysis context allocated using MblobAlloc().
	M_BLOB_RESULT	Specifies a MIL blob analysis result buffer allocated using MblobAllocResult().
	M_CAL_CONTEXT	Specifies a MIL camera calibration context allocated using McalAlloc().
	M_CAL_FIXTURING_OFFSET	Specifies a MIL fixturing offset object allocated using McalAlloc() with M_FIXTURING_OFFSET.
	M_CODE_CONTEXT	Specifies a MIL code context allocated using McolAlloc().
	M_CODE_MODEL	Specifies a MIL code model allocated using McodeModel() with M_ADD.
	M_CODE_RESULT	Specifies a MIL code result buffer allocated using McodeAllocResult().
	M_COL_MATCH_CONTEXT	Specifies a MIL color analysis context (for matching) allocated using McolAlloc() with M_COLOR_MATCHING.
	M_COL_MATCH_RESULT	Specifies a MIL color analysis result buffer (for matching) allocated using McolAllocResult() with M_COLOR_MATCHING_RESULT.
	M_COL_RELATIVE_CALIBRATION_CONTEXT	Specifies a MIL relative color calibration context allocated using McolAlloc() with M_COLOR_CALIBRATION_RELATIVE.
	M_COM_CONTEXT	Specifies a MIL industrial communication context allocated using McomAlloc().
	M_COUNT_LIST	Specifies a MIL count list result buffer allocated using MimAllocResult() with M_COUNT_LIST.
	M_DIGITIZER	Specifies a MIL digitizer allocated using MdigAlloc().
	M_DISPLAY	Specifies a MIL display allocated using MdispAlloc().
	M_DMR_CONTEXT	Specifies a MIL SureDotOCR context allocated using MdmrAlloc().
	M_DMR_RESULT	Specifies a MIL SureDotOCR result buffer allocated using MdmrAllocResult().
	M_EDGE_CONTOUR	Specifies a MIL edge contour context allocated using MedgeAlloc() with M_CONTOUR.
	M_EDGE_CREST	Specifies a MIL edge crest context allocated using MedgeAlloc() with M_CREST.
	M_EDGE_RESULT	Specifies a MIL edge result buffer allocated using MedgeAllocResult().
	M_EVENT	Specifies a MIL event allocated using MthrAlloc() with M_EVENT.
	M_EVENT_LIST	Specifies a MIL event list result buffer allocated using MimAllocResult() with M_EVENT_LIST.
	M_EXTREME_LIST	Specifies a MIL extreme list result buffer allocated using MimAllocResult() with M_EXTREME_LIST.
	M_FIND_ORIENTATION_LIST	Specifies a MIL find orientation list result buffer allocated using MimAllocResult() with M_FIND_ORIENTATION_LIST.
	M_GRAPHIC_CONTEXT	Specifies a MIL graphics context allocated using MgraAlloc().
	M_GRAPHIC_LIST	Specifies a MIL graphics list allocated using MgraAllocList().
	M_HIST_LIST	Specifies a MIL histogram list result buffer allocated using MimAllocResult() with M_HIST_LIST.
	M_IM_CONTEXT	Specifies a MIL image processing context allocated using MimAlloc().
	M_IMAGE	Specifies a MIL image buffer allocated using MbufAllocColor() with M_IMAGE.
	M_KERNEL	Specifies a MIL kernel buffer allocated using MbufAlloc2d() with M_KERNEL.
	M_LOCATE_PEAK_1D_RESULT	Specifies a MIL locate 1D peak result buffer allocated using MimAllocResult() with M_LOCATE_PEAK_1D_RESULT.
	M_LUT	Specifies a MIL LUT buffer allocated using MbufAlloc2d() with M_LUT.
	M_MEAS_CONTEXT	Specifies a MIL measurement context allocated using MmeasAllocContext().
	M_MEAS_MARKER	Specifies a MIL measurement marker allocated using MmeasAllocMarker().
	M_MEAS_RESULT	Specifies a MIL measurement result buffer allocated using MmeasAllocResult().
	M_MESSAGE_MAILBOX	Specifies a MIL message mailbox allocated using MobjAlloc().
	M_MET_CONTEXT	Specifies a MIL metrology context allocated using MmetAlloc() with M_CONTEXT.
	M_MET_DERIVED_GEOMETRY_REGION	Specifies a MIL metrology derived geometry region object allocated using MmetAlloc() with M_DERIVED_GEOMETRY_REGION.
	M_MET_RESULT	Specifies a MIL metrology result buffer allocated using MmetAllocResult().
	M_MOD_GEOMETRIC	Specifies a MIL Model Finder context allocated using MmodAlloc() with M_GEOMETRIC.
	M_MOD_GEOMETRIC_CONTROLLED	Specifies a MIL Model Finder context allocated using MmodAlloc() with M_GEOMETRIC_CONTROLLED.
	M_MOD_RESULT	Specifies a MIL Model Finder result buffer allocated using MmodAllocResult() with M_DEFAULT.
	M_MOD_SHAPE_RESULT	Specifies a MIL Model Finder result buffer allocated using MmodAllocResult() with M_SHAPE_CIRCLE.
	M_MUTEX	Specifies a MIL mutex allocated using MthrAlloc() with M_MUTEX.
	M_OCR_FONT	Specifies a MIL character recognition font context allocated using MocrAllocFont().
	M_OCR_RESULT	Specifies a MIL character recognition result buffer allocated using MocrAllocResult().
	M_PAT_CONTEXT	Specifies a MIL pattern matching context allocated using MpatAlloc().
	M_PAT_RESULT	Specifies a MIL pattern matching result buffer allocated using MpatAllocResult().
	M_PROJ_LIST	Specifies a MIL project list result buffer allocated using MimAllocResult() with M_PROJ_LIST.
	M_REG_EDOF_CONTEXT	Specifies a MIL registration context allocated using MregAlloc() with M_EXTENDED_DEPTH_OF_FIELD.
	M_REG_EDOF_RESULT	Specifies a MIL registration result buffer allocated using MregAllocResult() with M_EXTENDED_DEPTH_OF_FIELD_RESULT.
	M_REG_STITCHING_CONTEXT	Specifies a MIL registration context allocated using MregAlloc() with M_STITCHING.
	M_REG_STITCHING_RESULT	Specifies a MIL registration result buffer allocated using MregAllocResult() with M_STITCHING_RESULT.
	M_SELECTABLE_THREAD	Specifies a MIL selectable thread allocated using MthrAlloc() with M_SELECTABLE_THREAD.
	M_SEQUENCE_CONTEXT	Specifies a MIL sequence context allocated using MseqAlloc().
	M_SHAPE_CIRCLE	Specifies a MIL Model Finder context allocated using MmodAlloc() with M_SHAPE_CIRCLE.
	M_STATISTICS_RESULT	Specifies a MIL MimStatCalculate() result buffer allocated using MimAllocResult() with M_STATISTICS_RESULT.
	M_STR_CONTEXT	Specifies a MIL string context allocated using MstrAlloc().
	M_STR_RESULT	Specifies a MIL string result buffer allocated using MstrAllocResult().
	M_STRUCT_ELEMENT	Specifies a MIL structuring element buffer allocated using MbufAlloc2d() with M_STRUCT_ELEMENT.
	M_SYS_IO_CONTEXT	Specifies a MIL system I/O context allocated using MsysIoAlloc().
	M_SYSTEM	Specifies a MIL system context allocated using MsysAlloc().
	M_THREAD	Specifies a MIL thread context object allocated using MthrAlloc() with M_THREAD.
	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: To set the offset (summarize) Specifies a MIL object from group one of the user-defined object types allocated using MfuncAllocId() with M_USER_OBJECT_1. (more details...)
	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: To set the offset (summarize) Specifies a MIL object from group two of the user-defined object types allocated using MfuncAllocId() with M_USER_OBJECT_2. (more details...)
	M_WAVELET_TRANSFORM_RESULT	Specifies a MIL wavelet transform result buffer allocated using MimAllocResult() with M_WAVELET_TRANSFORM_RESULT.

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).

For distinguishing between the different object types
Combination value	Description
Value	Specifies the offset within the selected object type group. The value must have only one of its 16 least significant bits set. (summarize) Specifies the offset within the selected object type group. (more details...)

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

For inquiring message mailbox settings
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_INIT_FLAG		Inquires the initialization of the allocated object. SET (summarize) Inquires the initialization of the allocated object. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	M_OVERWRITE	//For message mailbox objects Specifies that only one message can be kept in the mailbox and is replaced at each write. INFO //For message mailbox objects Specifies that only one message can be kept in the mailbox and is replaced at each write. INFO
	M_QUEUE	//For message mailbox objects Specifies that multiple messages can be queued in the mailbox. INFO //For message mailbox objects Specifies that multiple messages can be queued in the mailbox. INFO
M_MESSAGE_COUNT		Inquires the number of messages in the message mailbox. (summarize) Inquires the number of messages in the message mailbox. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	Value >= 0	Specifies the number of messages in the message mailbox.
M_MESSAGE_LENGTH		Inquires the length of the next message in the message mailbox. (summarize) Inquires the length of the next message in the message mailbox. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	Value > 0	Specifies the length of the next message in the message mailbox.
M_QUEUE_FULL_MODE		Inquires the behavior of the queue when the message limit is attained. SET (summarize) Inquires the behavior of the queue when the message limit is attained. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	M_DEFAULT	Same as M_WRITE_TIMEOUT.
	M_ERROR	Specifies that a MIL error is generated when the message limit is attained.
	M_WRITE_TIMEOUT	Specifies to wait for the write timeout to elapse.
M_QUEUE_SIZE		Inquires the number of messages the queue can hold. SET (summarize) Inquires the number of messages the queue can hold. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	M_DEFAULT	Specifies the default value; the default value is 100 messages.
	Value > 0	Specifies the number of messages the queue can hold.
M_READ_TIMEOUT		Inquires the amount of time to wait for a read operation. SET (summarize) Inquires the amount of time to wait for a read operation. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	M_DEFAULT	Same as M_INFINITE.
	M_INFINITE	Specifies that the read operation waits indefinitely.
	Value > 0	Specifies the amount of time to wait, in msecs.
M_WRITE_TIMEOUT		Inquires the amount of time to wait for a write operation. SET (summarize) Inquires the amount of time to wait for a write operation. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT
	M_DEFAULT	Same as M_INFINITE.
	M_INFINITE	Specifies that the write operation waits indefinitely.
	Value > 0	Specifies the amount of time to wait, in msecs.

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.