MobjInquire
Inquire about an Aurora Imaging Library object setting or information associated with the Aurora Imaging Library object.
Syntax
AIL_INT MobjInquire(
AIL_ID ObjectId, //in
AIL_INT64 InquireType, //in
void * UserVarPtr //out
)
Description
This function inquires about general settings of an Aurora Imaging Library object. You can inquire about read/write properties of a remote Aurora Imaging Library object and about information associated with an Aurora Imaging Library object. You can also inquire about message mailboxes.
Parameters
ObjectId (in, AIL_ID)
Specifies the identifier of the Aurora Imaging Library object about which to inquire. The Aurora Imaging Library object can be an Aurora Imaging Library utility object (allocated using MobjAlloc) or any other Aurora Imaging Library object, except for Aurora Imaging Library objects allocated using MfuncAlloc.
InquireType (in, AIL_INT64)
Specifies the Aurora Imaging Library object setting about which to inquire.
UserVarPtr *(out, void)
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.
Parameter Associations
For inquiring about Aurora Imaging Library object settings
The following InquireType parameter settings can be specified for any Aurora Imaging Library objects allocated using an M...Alloc function.
M_DAIL_PUBLISH
Inquires the Aurora Imaging Library object's remote access rights.
| Value | Description |
|---|---|
M_NO (default) | Specifies that the Aurora Imaging Library object will not be visible. |
M_READ_ONLY | Specifies that the Aurora Imaging Library object can only be used as a source or to be inquired. |
M_READ_WRITE | Specifies that the Aurora Imaging Library object can be used as a destination or can be controlled by Aurora Imaging Library functions. |
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: Note that this inquire type returns an empty string if the object was not loaded or restored from a file.
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: Note that this inquire type returns an empty string if the object was not loaded or restored from a file.
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: Note that this inquire type returns an empty string if the object was not loaded or restored from a file.
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: Note that this inquire type returns an empty string if the object was not loaded or restored from a file.
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: Note that this inquire type returns an empty string if the object was not loaded or restored from a file.
M_OBJECT_NAME
Inquires the Aurora Imaging Library object's user-defined name.
M_OBJECT_TYPE
Inquires the type of the specified Aurora Imaging Library object.
| Value | Description |
|---|---|
M_APPLICATION | Specifies an Aurora Imaging Library application context allocated using MappAlloc. |
M_ARRAY | Specifies an Aurora Imaging Library array buffer allocated using MbufAlloc2d with M_ARRAY. |
M_AUGMENTATION_RESULT | Specifies an Aurora Imaging Library augmentation result buffer allocated using MimAllocResult with M_AUGMENTATION_RESULT. |
M_CONTAINER | Specifies an Aurora Imaging Library container buffer allocated using MbufAllocContainer. |
M_COUNT_LIST | Specifies an Aurora Imaging Library count list result buffer allocated using MimAllocResult with M_COUNT_LIST. |
M_DIGITIZER | Specifies an Aurora Imaging Library digitizer allocated using MdigAlloc. |
M_DISPLAY | Specifies an Aurora Imaging Library display allocated using MdispAlloc. |
M_EVENT | Specifies an Aurora Imaging Library event allocated using MthrAlloc withM_EVENT. |
M_EVENT_LIST | Specifies an Aurora Imaging Library event list result buffer allocated using MimAllocResult with M_EVENT_LIST. |
M_EXTREME_LIST | Specifies an Aurora Imaging Library extreme list result buffer allocated using MimAllocResult with M_EXTREME_LIST. |
M_FIND_ORIENTATION_LIST | Specifies an Aurora Imaging Library find orientation list result buffer allocated using MimAllocResult with M_FIND_ORIENTATION_LIST. |
M_GRAPHIC_CONTEXT | Specifies an Aurora Imaging Library 2D graphics context allocated using MgraAlloc. |
M_GRAPHIC_LIST | Specifies an Aurora Imaging Library 2D graphics list allocated using MgraAllocList. |
M_HIST_LIST | Specifies an Aurora Imaging Library histogram list result buffer allocated using MimAllocResult with M_HIST_LIST. |
M_HTTP_SERVER | Specifies an HTTP server allocated using MobjAlloc with M_HTTP_SERVER. |
M_IM_CONTEXT | Specifies an Aurora Imaging Library image processing context allocated using MimAlloc. |
M_IMAGE | Specifies an Aurora Imaging Library image buffer allocated using MbufAllocColor with M_IMAGE. |
M_KERNEL | Specifies an Aurora Imaging Library kernel buffer allocated using MbufAlloc2d with M_KERNEL. |
M_LOCATE_DIFFERENCE_RESULT | Specifies an Aurora Imaging Library locate difference result buffer allocated using MimAllocResult with M_LOCATE_DIFFERENCE_RESULT. |
M_LOCATE_PEAK_1D_RESULT | Specifies an Aurora Imaging Library locate 1D peak result buffer allocated using MimAllocResult with M_LOCATE_PEAK_1D_RESULT. |
M_LUT | Specifies an Aurora Imaging Library LUT buffer allocated using MbufAlloc2d with M_LUT. |
M_MESSAGE_MAILBOX | Specifies an Aurora Imaging Library message mailbox allocated using MobjAlloc. |
M_PROJ_LIST | Specifies an Aurora Imaging Library project list result buffer allocated using MimAllocResult with M_PROJ_LIST. |
M_SEQUENCE_CONTEXT | Specifies an Aurora Imaging Library sequence context allocated using MseqAlloc. |
M_STATISTICS_RESULT | Specifies an Aurora Imaging Library MimStatCalculate result buffer allocated using MimAllocResult with M_STATISTICS_RESULT. |
M_STRUCT_ELEMENT | Specifies an Aurora Imaging Library structuring element buffer allocated using MbufAlloc2d with M_STRUCT_ELEMENT. |
M_SYS_IO_CONTEXT | Specifies an Aurora Imaging Library system I/O context allocated using MsysIoAlloc. |
M_SYSTEM | Specifies an Aurora Imaging Library system context allocated using MsysAlloc. |
M_WAVELET_TRANSFORM_RESULT | Specifies an Aurora Imaging Library wavelet transform result buffer allocated using MimAllocResult with M_WAVELET_TRANSFORM_RESULT. |
M_3D_DISPLAY | Specifies an Aurora Imaging Library 3D display allocated using M3ddispAlloc. |
M_3D_DISPLAY_PICKING_AREA_CONTEXT | Specifies an Aurora Imaging Library picking area context allocated using M3ddispAlloc with M_PICKING_AREA_CONTEXT. |
M_3D_DISPLAY_PICKING_AREA_RESULT | Specifies an Aurora Imaging Library picking area result buffer allocated using M3ddispAllocResult with M_PICKING_AREA_RESULT. |
M_3D_DISPLAY_PICKING_CONTEXT | Specifies an Aurora Imaging Library picking context allocated using M3ddispAlloc with M_PICKING_CONTEXT. |
M_3D_DISPLAY_PICKING_RESULT | Specifies an Aurora Imaging Library picking result buffer allocated using M3ddispAllocResult with M_PICKING_RESULT. |
M_3D_GRAPHIC_LIST | Specifies an Aurora Imaging Library 3D graphics list allocated using M3dgraAlloc. |
M_3DBLOB_CALCULATE_CONTEXT | Specifies an Aurora Imaging Library 3D blob context that can be used with M3dblobCalculate, allocated using M3dblobAlloc with M_CALCULATE_CONTEXT. |
M_3DBLOB_DRAW_3D_CONTEXT | Specifies an Aurora Imaging Library 3D blob context that can be used with M3dblobDraw3d, allocated using M3dblobAlloc with M_DRAW_3D_CONTEXT. |
M_3DBLOB_SEGMENTATION_CONTEXT | Specifies an Aurora Imaging Library 3D blob context that can be used with M3dblobSegment, allocated using M3dblobAlloc with M_SEGMENTATION_CONTEXT. |
M_3DBLOB_SEGMENTATION_RESULT | Specifies an Aurora Imaging Library 3D blob result buffer for segmentation results, allocated using M3dblobAllocResult with M_SEGMENTATION_RESULT. |
M_3DGEO_GEOMETRY | Specifies an Aurora Imaging Library 3D geometry object allocated using M3dgeoAlloc with M_GEOMETRY. |
M_3DGEO_TRANSFORMATION_MATRIX | Specifies an Aurora Imaging Library 3D transformation matrix object allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. |
M_3DIM_CALCULATE_MAP_SIZE_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimCalculateMapSize, allocated using M3dimAlloc with M_CALCULATE_MAP_SIZE_CONTEXT. |
M_3DIM_FILL_GAPS_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimFillGaps, allocated using M3dimAlloc with M_FILL_GAPS_CONTEXT. |
M_3DIM_FILTER_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimFilter, allocated using M3dimAlloc with M_FILTER_CONTEXT. |
M_3DIM_FIND_TRANSFORMATION_RESULT | Specifies an Aurora Imaging Library 3D image processing result buffer for find transformation results, allocated using M3dimAllocResult with M_FIND_TRANSFORMATION_RESULT. |
M_3DIM_LATTICE_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimLattice, allocated using M3dimAlloc with M_LATTICE_CONTEXT. |
M_3DIM_LATTICE_RESULT | Specifies an Aurora Imaging Library 3D image processing result buffer for lattice results, allocated using M3dimAllocResult with M_LATTICE_RESULT. |
M_3DIM_MESH_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimMesh, allocated using M3dimAlloc with M_MESH_CONTEXT. |
M_3DIM_NORMALS_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimNormals, allocated using M3dimAlloc with M_NORMALS_CONTEXT. |
M_3DIM_OUTLIERS_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimOutliers, allocated using M3dimAlloc with M_OUTLIERS_CONTEXT. |
M_3DIM_PROFILE_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimProfileEx, allocated using M3dimAlloc with M_PROFILE_CONTEXT. |
M_3DIM_PROFILE_RESULT | Specifies an Aurora Imaging Library 3D image processing result buffer for profile results, allocated using M3dimAllocResult with M_PROFILE_RESULT. |
M_3DIM_PROJECT_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimProjectEx, allocated using M3dimAlloc with M_PROJECT_CONTEXT. |
M_3DIM_REMAP_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimRemapDepthMap, allocated using M3dimAlloc with M_REMAP_CONTEXT. |
M_3DIM_STATISTICS_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimStat, allocated using M3dimAlloc with M_STATISTICS_CONTEXT. |
M_3DIM_STATISTICS_RESULT | Specifies an Aurora Imaging Library 3D image processing result buffer used to store M3dimStat results, and is allocated using M3dimAllocResult with M_STATISTICS_RESULT. |
M_3DIM_STITCH_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimMerge, allocated using M3dimAlloc with M_STITCH_CONTEXT. |
M_3DIM_SUBSAMPLE_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimSample, allocated using M3dimAlloc with M_SUBSAMPLE_CONTEXT. |
M_3DIM_SURFACE_SAMPLE_CONTEXT | Specifies an Aurora Imaging Library 3D image processing context that can be used with M3dimSample, allocated using M3dimAlloc with M_SURFACE_SAMPLE_CONTEXT. |
M_3DMAP_ALIGN_CONTEXT | Specifies an Aurora Imaging Library 3D align context allocated using M3dmapAlloc with M_ALIGN_CONTEXT. |
M_3DMAP_ALIGN_RESULT | Specifies an Aurora Imaging Library 3D align result buffer allocated using M3dmapAllocResult with M_ALIGN_RESULT. |
M_3DMAP_DEPTH_CORRECTED_DATA | Specifies an Aurora Imaging Library 3D reconstruction result buffer allocated using M3dmapAllocResult with M_DEPTH_CORRECTED_DATA. |
M_3DMAP_DRAW_3D_CONTEXT | Specifies an Aurora Imaging Library 3D draw context allocated using M3dmapAlloc with M_DRAW_3D_CONTEXT. |
M_3DMAP_LASER_CALIBRATION_DATA | Specifies an Aurora Imaging Library 3D reconstruction result buffer allocated using M3dmapAllocResult with M_LASER_CALIBRATION_DATA. |
M_3DMAP_LASER_CONTEXT | Specifies an Aurora Imaging Library 3D reconstruction context allocated using M3dmapAlloc with M_LASER. |
M_3DMAP_POINT_CLOUD_RESULT | Specifies an Aurora Imaging Library 3D reconstruction result buffer allocated using M3dmapAllocResult with M_POINT_CLOUD_RESULT. |
M_3DMEAS_DRAW_3D_PATH_CONTEXT | Specifies an Aurora Imaging Library draw path 3D measurement context allocated using M3dmeasAlloc with M_DRAW_3D_PATH_CONTEXT. |
M_3DMEAS_DRAW_3D_PROFILE_CONTEXT | Specifies an Aurora Imaging Library draw profile 3D measurement context allocated using M3dmeasAlloc with M_DRAW_3D_PROFILE_CONTEXT. |
M_3DMEAS_DRAW_3D_TEMPLATE_CONTEXT | Specifies an Aurora Imaging Library draw template 3D measurement context allocated using M3dmeasAlloc with M_DRAW_3D_TEMPLATE_CONTEXT. |
M_3DMEAS_FIND_MARKER_PATH_CONTEXT | Specifies an Aurora Imaging Library path 3D measurement context allocated using M3dmeasAlloc with M_FIND_MARKER_PATH_CONTEXT. |
M_3DMEAS_FIND_MARKER_PATH_RESULT | Specifies an Aurora Imaging Library path 3D measurement result allocated using M3dmeasAllocResult with M_FIND_MARKER_PATH_RESULT. |
M_3DMEAS_FIND_MARKER_PROFILE_CONTEXT | Specifies an Aurora Imaging Library profile 3D measurement context allocated using M3dmeasAlloc with M_FIND_MARKER_PROFILE_CONTEXT. |
M_3DMEAS_FIND_MARKER_PROFILE_RESULT | Specifies an Aurora Imaging Library profile 3D measurement result allocated using M3dmeasAllocResult with M_FIND_MARKER_PROFILE_RESULT. |
M_3DMEAS_FIND_MARKER_TEMPLATE_CONTEXT | Specifies an Aurora Imaging Library template 3D measurement context allocated using M3dmeasAlloc with M_FIND_MARKER_TEMPLATE_CONTEXT. |
M_3DMEAS_FIND_MARKER_TEMPLATE_RESULT | Specifies an Aurora Imaging Library template 3D measurement result allocated using M3dmeasAllocResult with M_FIND_MARKER_TEMPLATE_RESULT. |
M_3DMEAS_FIT_CONTEXT | Specifies an Aurora Imaging Library fit 3D measurement context allocated using M3dmeasAlloc with M_FIT_CONTEXT. |
M_3DMET_CALCULATE_RESULT | Specifies an Aurora Imaging Library calculate 3D metrology result buffer allocated using M3dmetAllocResult with M_CALCULATE_RESULT. |
M_3DMET_DISTANCE_CONTEXT | Specifies an Aurora Imaging Library distance 3D metrology context allocated using M3dmetAlloc with M_DISTANCE_CONTEXT. |
M_3DMET_DRAW_3D_CONTEXT | Specifies an Aurora Imaging Library draw 3D metrology context allocated using M3dmetAlloc with M_DRAW_3D_CONTEXT. |
M_3DMET_FIT_CONTEXT | Specifies an Aurora Imaging Library fit 3D metrology context allocated using M3dmetAlloc with M_FIT_CONTEXT. |
M_3DMET_FIT_RESULT | Specifies an Aurora Imaging Library fit 3D metrology result buffer allocated using M3dmetAllocResult with M_FIT_RESULT. |
M_3DMET_STATISTICS_CONTEXT | Specifies an Aurora Imaging Library statistics 3D metrology context allocated using M3dmetAlloc with M_STATISTICS_CONTEXT. |
M_3DMET_STATISTICS_RESULT | Specifies an Aurora Imaging Library statistics 3D metrology result buffer allocated using M3dmetAllocResult with M_STATISTICS_RESULT. |
M_3DMET_VOLUME_CONTEXT | Specifies an Aurora Imaging Library calculate volume 3D metrology context allocated using M3dmetAlloc with M_VOLUME_CONTEXT. |
M_3DMOD_DRAW_3D_CONTEXT | Specifies an Aurora Imaging Library draw 3D model finder context that can be allocated using M3dmodAlloc with M_DRAW_3D_GEOMETRIC_CONTEXT (to draw occurrences of geometric models). |
M_3DMOD_DRAW_3D_SURFACE_CONTEXT | Specifies an Aurora Imaging Library draw 3D model finder context that can be allocated using M3dmodAlloc with M_DRAW_3D_SURFACE_CONTEXT (to draw occurrences of surface models). |
M_3DMOD_FIND_BOX_CONTEXT | Specifies an Aurora Imaging Library box 3D model finder context that can be allocated using M3dmodAlloc with M_FIND_BOX_CONTEXT. |
M_3DMOD_FIND_BOX_RESULT | Specifies an Aurora Imaging Library box 3D model finder result buffer allocated using M3dmodAllocResult with M_FIND_BOX_RESULT. |
M_3DMOD_FIND_CYLINDER_CONTEXT | Specifies an Aurora Imaging Library cylinder 3D model finder context that can be allocated using M3dmodAlloc with M_FIND_CYLINDER_CONTEXT. |
M_3DMOD_FIND_CYLINDER_RESULT | Specifies an Aurora Imaging Library cylinder 3D model finder result buffer allocated using M3dmodAllocResult with M_FIND_CYLINDER_RESULT. |
M_3DMOD_FIND_PLANAR_SURFACE_CONTEXT | Specifies an Aurora Imaging Library planar surface 3D model finder context that can be allocated using M3dmodAlloc with M_FIND_PLANAR_SURFACE_CONTEXT. |
M_3DMOD_FIND_PLANAR_SURFACE_RESULT | Specifies an Aurora Imaging Library planar surface 3D model finder result buffer allocated using M3dmodAllocResult with M_FIND_PLANAR_SURFACE_RESULT. |
M_3DMOD_FIND_RECTANGULAR_PLANE_CONTEXT | Specifies an Aurora Imaging Library rectangular plane 3D model finder context that can be allocated using M3dmodAlloc with M_FIND_RECTANGULAR_PLANE_CONTEXT. |
M_3DMOD_FIND_RECTANGULAR_PLANE_RESULT | Specifies an Aurora Imaging Library rectangular plane 3D model finder result buffer allocated using M3dmodAllocResult with M_FIND_RECTANGULAR_PLANE_RESULT. |
M_3DMOD_FIND_SPHERE_CONTEXT | Specifies an Aurora Imaging Library sphere 3D model finder context that can be allocated using M3dmodAlloc with M_FIND_SPHERE_CONTEXT. |
M_3DMOD_FIND_SPHERE_RESULT | Specifies an Aurora Imaging Library sphere 3D model finder result buffer allocated using M3dmodAllocResult with M_FIND_SPHERE_RESULT. |
M_3DMOD_FIND_SURFACE_CONTEXT | Specifies an Aurora Imaging Library surface 3D model finder context that can be allocated using M3dmodAlloc with M_FIND_SURFACE_CONTEXT. |
M_3DMOD_FIND_SURFACE_RESULT | Specifies an Aurora Imaging Library surface 3D model finder result buffer allocated using M3dmodAllocResult with M_FIND_SURFACE_RESULT. |
M_3DREG_DRAW_3D_CONTEXT | Specifies an Aurora Imaging Library draw 3D registration context that can be used with M3dregDraw3d, allocated using M3dregAlloc with M_DRAW_3D_CONTEXT. |
M_3DREG_PAIRWISE_REGISTRATION_CONTEXT | Specifies an Aurora Imaging Library pairwise 3D registration context allocated using M3dregAlloc with M_PAIRWISE_REGISTRATION_CONTEXT. |
M_3DREG_PAIRWISE_REGISTRATION_RESULT | Specifies an Aurora Imaging Library pairwise 3D registration result buffer allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. |
M_AGM_EDGE_BASED_FIND_CONTEXT | Specifies an Aurora Imaging Library Advanced Geometric Matching context allocated using MagmAlloc with M_GLOBAL_EDGE_BASED_FIND. |
M_AGM_EDGE_BASED_FIND_RESULT | Specifies an Aurora Imaging Library Advanced Geometric Matching result buffer allocated using MagmAllocResult with M_GLOBAL_EDGE_BASED_FIND_RESULT. |
M_AGM_EDGE_BASED_TRAIN_CONTEXT | Specifies an Aurora Imaging Library Advanced Geometric Matching context allocated using MagmAlloc with M_GLOBAL_EDGE_BASED_TRAIN. |
M_AGM_EDGE_BASED_TRAIN_RESULT | Specifies an Aurora Imaging Library Advanced Geometric Matching result buffer allocated using MagmAllocResult with M_GLOBAL_EDGE_BASED_TRAIN_RESULT. |
M_BEAD_CONTEXT | Specifies an Aurora Imaging Library bead context allocated using MbeadAlloc. |
M_BEAD_RESULT | Specifies an Aurora Imaging Library bead result buffer allocated using MbeadAllocResult. |
M_BLOB_CONTEXT | Specifies an Aurora Imaging Library blob analysis context allocated using MblobAlloc. |
M_BLOB_RESULT | Specifies an Aurora Imaging Library blob analysis result buffer allocated using MblobAllocResult. |
M_CAL_CALCULATE_HAND_EYE_CONTEXT | Specifies an Aurora Imaging Library calculate hand-eye context (hand-eye calibration) allocated using McalAlloc with M_CALCULATE_HAND_EYE_CONTEXT. |
M_CAL_CALCULATE_HAND_EYE_RESULT | Specifies an Aurora Imaging Library calculate hand-eye result buffer allocated using McalAllocResult with M_CALCULATE_HAND_EYE_RESULT. |
M_CAL_CONTEXT | Specifies an Aurora Imaging Library camera calibration context allocated using McalAlloc. |
M_CAL_DRAW_3D_CONTEXT | Specifies an Aurora Imaging Library 3D draw calibration context allocated using McalAllocwith M_DRAW_3D_CONTEXT. |
M_CAL_FIXTURING_OFFSET | Specifies an Aurora Imaging Library fixturing offset object allocated using McalAlloc with M_FIXTURING_OFFSET. |
M_CLASS_CLASSIFIER_ANO_PREDEFINED_CONTEXT | Specifies an Aurora Imaging Library predefined anomaly detection classifier context, allocated using MclassAlloc with M_CLASSIFIER_ANO_PREDEFINED. |
M_CLASS_CLASSIFIER_CNN_PREDEFINED_CONTEXT | Specifies an Aurora Imaging Library predefined CNN classifier context, allocated using MclassAlloc with M_CLASSIFIER_CNN_PREDEFINED. |
M_CLASS_CLASSIFIER_DET_PREDEFINED_CONTEXT | Specifies an Aurora Imaging Library predefined object detection classifier context, allocated using MclassAlloc with M_CLASSIFIER_DET_PREDEFINED. |
M_CLASS_CLASSIFIER_ONNX_CONTEXT | Specifies an Aurora Imaging Library ONNX classifier context, allocated using MclassAlloc with M_CLASSIFIER_ONNX. |
M_CLASS_CLASSIFIER_SEG_PREDEFINED_CONTEXT | Specifies an Aurora Imaging Library predefined segmentation classifier context, allocated using MclassAlloc with M_CLASSIFIER_SEG_PREDEFINED. |
M_CLASS_CLASSIFIER_TREE_ENSEMBLE_CONTEXT | Specifies an Aurora Imaging Library tree ensemble classifier context, allocated using MclassAlloc with M_CLASSIFIER_TREE_ENSEMBLE. |
M_CLASS_DATASET_FEATURES | Specifies an Aurora Imaging Library features dataset context, allocated using MclassAlloc with M_DATASET_FEATURES. |
M_CLASS_DATASET_IMAGES | Specifies an Aurora Imaging Library images dataset context, allocated using MclassAlloc with M_DATASET_IMAGES. |
M_CLASS_PREDICT_ANO_RESULT | Specifies an Aurora Imaging Library anomaly detection prediction result buffer, allocated usingMclassAllocResult with M_PREDICT_ANO_RESULT. |
M_CLASS_PREDICT_CNN_RESULT | Specifies an Aurora Imaging Library CNN prediction result buffer, allocated usingMclassAllocResult with M_PREDICT_CNN_RESULT. |
M_CLASS_PREDICT_DET_RESULT | Specifies an Aurora Imaging Library object detection prediction result buffer, allocated usingMclassAllocResult with M_PREDICT_DET_RESULT. |
M_CLASS_PREDICT_ONNX_RESULT | Specifies an ONNX prediction result buffer, allocated usingMclassAllocResult with M_PREDICT_ONNX_RESULT. |
M_CLASS_PREDICT_SEG_RESULT | Specifies an Aurora Imaging Library segmentation prediction result buffer, allocated usingMclassAllocResult with M_PREDICT_SEG_RESULT. |
M_CLASS_PREDICT_TREE_ENSEMBLE_RESULT | Specifies an Aurora Imaging Library tree ensemble prediction result buffer, allocated usingMclassAllocResult with M_PREDICT_TREE_ENSEMBLE_RESULT. |
M_CLASS_PREPARE_IMAGES_CNN | Specifies an Aurora Imaging Library CNN data preparation context, allocated using MclassAlloc with M_PREPARE_IMAGES_CNN. |
M_CLASS_PREPARE_IMAGES_DET | Specifies an Aurora Imaging Library object detection data preparation context, allocated using MclassAlloc with M_PREPARE_IMAGES_DET. |
M_CLASS_PREPARE_IMAGES_SEG | Specifies an Aurora Imaging Library segmentation data preparation context, allocated using MclassAlloc with M_PREPARE_IMAGES_SEG. |
M_CLASS_STAT_ANO_CONTEXT | Specifies an Aurora Imaging Library statistics classification context for anomaly detection, allocated using MclassAlloc with M_STAT_ANO. |
M_CLASS_STAT_ANO_RESULT | Specifies an Aurora Imaging Library statistics classification result buffer for anomaly detection, allocated using MclassAllocResult with M_STAT_ANO_RESULT. |
M_CLASS_STAT_CNN_CONTEXT | Specifies an Aurora Imaging Library statistics classification context for image classification, allocated using MclassAlloc with M_STAT_CNN. |
M_CLASS_STAT_CNN_RESULT | Specifies an Aurora Imaging Library statistics classification result buffer for image classification, allocated using MclassAllocResult with M_STAT_CNN_RESULT. |
M_CLASS_STAT_DET_CONTEXT | Specifies an Aurora Imaging Library statistics classification context for object detection, allocated using MclassAlloc with M_STAT_DET. |
M_CLASS_STAT_DET_RESULT | Specifies an Aurora Imaging Library statistics classification result buffer for object detection, allocated using MclassAllocResult with M_STAT_DET_RESULT. |
M_CLASS_STAT_SEG_CONTEXT | Specifies an Aurora Imaging Library statistics classification context for segmentation, allocated using MclassAlloc with M_STAT_SEG. |
M_CLASS_STAT_SEG_RESULT | Specifies an Aurora Imaging Library statistics classification result buffer for segmentation, allocated using MclassAllocResult with M_STAT_SEG_RESULT. |
M_CLASS_STAT_TREE_ENSEMBLE_CONTEXT | Specifies an Aurora Imaging Library statistics classification context for feature classification, allocated using MclassAlloc with M_STAT_TREE_ENSEMBLE. |
M_CLASS_STAT_TREE_ENSEMBLE_RESULT | Specifies an Aurora Imaging Library statistics classification result buffer for feature classification, allocated using MclassAllocResult with M_STAT_TREE_ENSEMBLE_RESULT. |
M_CLASS_TRAIN_ANO_CONTEXT | Specifies an Aurora Imaging Library anomaly detection training context, allocated using MclassAlloc with M_TRAIN_ANO. |
M_CLASS_TRAIN_ANO_RESULT | Specifies an Aurora Imaging Library anomaly detection training result buffer, allocated using MclassAllocResult with M_TRAIN_ANO_RESULT. |
M_CLASS_TRAIN_CNN_CONTEXT | Specifies an Aurora Imaging Library CNN training context, allocated using MclassAlloc with M_TRAIN_CNN. |
M_CLASS_TRAIN_CNN_RESULT | Specifies an Aurora Imaging Library CNN training result buffer, allocated using MclassAllocResult with M_TRAIN_CNN_RESULT. |
M_CLASS_TRAIN_DET_CONTEXT | Specifies an Aurora Imaging Library object detection training context, allocated using MclassAlloc with M_TRAIN_DET. |
M_CLASS_TRAIN_DET_RESULT | Specifies an Aurora Imaging Library object detection training result buffer, allocated using MclassAllocResult with M_TRAIN_DET_RESULT. |
M_CLASS_TRAIN_SEG_CONTEXT | Specifies an Aurora Imaging Library segmentation training context, allocated using MclassAlloc with M_TRAIN_SEG. |
M_CLASS_TRAIN_SEG_RESULT | Specifies an Aurora Imaging Library segmentation training result buffer, allocated using MclassAllocResult with M_TRAIN_CNN_RESULT. |
M_CLASS_TRAIN_TREE_ENSEMBLE_CONTEXT | Specifies an Aurora Imaging Library tree ensemble training context, allocated using MclassAlloc with M_TRAIN_TREE_ENSEMBLE. |
M_CLASS_TRAIN_TREE_ENSEMBLE_RESULT | Specifies an Aurora Imaging Library tree ensemble training result buffer, allocated using MclassAllocResult with M_TRAIN_TREE_ENSEMBLE_RESULT. |
M_CODE_CONTEXT | Specifies an Aurora Imaging Library code context allocated using McolAlloc. |
M_CODE_DETECT_RESULT | Specifies an Aurora Imaging Library code detect result buffer allocated using McodeAllocResult. |
M_CODE_GRADE_RESULT | Specifies an Aurora Imaging Library code grade result buffer allocated using McodeAllocResult. |
M_CODE_MODEL | Specifies an Aurora Imaging Library code model allocated using McodeModel with M_ADD. |
M_CODE_READ_RESULT | Specifies an Aurora Imaging Library code read result buffer allocated using McodeAllocResult. |
M_CODE_TRAIN_RESULT | Specifies an Aurora Imaging Library code train result buffer allocated using McodeAllocResult. |
M_CODE_WRITE_RESULT | Specifies an Aurora Imaging Library code write result buffer allocated using McodeAllocResult. |
M_COL_MATCH_CONTEXT | Specifies an Aurora Imaging Library color analysis context (for matching) allocated using McolAlloc with M_COLOR_MATCHING. |
M_COL_MATCH_RESULT | Specifies an Aurora Imaging Library color analysis result buffer (for matching) allocated using McolAllocResult with M_COLOR_MATCHING_RESULT. |
M_COL_RELATIVE_CALIBRATION_CONTEXT | Specifies an Aurora Imaging Library relative color calibration context allocated using McolAlloc with M_COLOR_CALIBRATION_RELATIVE. |
M_COM_CONTEXT | Specifies an Aurora Imaging Library industrial communication context allocated using McomAlloc. |
M_DLOCR_DATASET | Specifies an Aurora Imaging Library Deep Learning OCR dataset allocated using MdlocrAllocDataset. |
M_DLOCR_FINETUNE_CONTEXT | Specifies an Aurora Imaging Library Deep Learning OCR fine-tuning context allocated using MdlocrAlloc. |
M_DLOCR_FINETUNE_RESULT | Specifies an Aurora Imaging Library Deep Learning OCR fine-tuning result buffer allocated using MdlocrAllocResult. |
M_DLOCR_READ_CONTEXT | Specifies an Aurora Imaging Library Deep Learning OCR read context allocated using MdlocrAlloc. |
M_DLOCR_READ_RESULT | Specifies an Aurora Imaging Library Deep Learning OCR read result buffer allocated using MdlocrAllocResult. |
M_DMR_CONTEXT | Specifies an Aurora Imaging Library SureDotOCR context allocated using MdmrAlloc. |
M_DMR_RESULT | Specifies an Aurora Imaging Library SureDotOCR result buffer allocated using MdmrAllocResult. |
M_EDGE_CONTOUR | Specifies an Aurora Imaging Library edge contour context allocated using MedgeAlloc with M_CONTOUR. |
M_EDGE_CREST | Specifies an Aurora Imaging Library edge crest context allocated using MedgeAlloc with M_CREST. |
M_EDGE_RESULT | Specifies an Aurora Imaging Library edge result buffer allocated using MedgeAllocResult. |
M_MEAS_CONTEXT | Specifies an Aurora Imaging Library measurement context allocated using MmeasAllocContext. |
M_MEAS_MARKER | Specifies an Aurora Imaging Library measurement marker allocated using MmeasAllocMarker. |
M_MEAS_RESULT | Specifies an Aurora Imaging Library measurement result buffer allocated using MmeasAllocResult. |
M_MET_CONTEXT | Specifies an Aurora Imaging Library metrology context allocated using MmetAlloc with M_CONTEXT. |
M_MET_DERIVED_GEOMETRY_REGION | Specifies an Aurora Imaging Library metrology derived geometry region object allocated using MmetAlloc with M_DERIVED_GEOMETRY_REGION. |
M_MET_RESULT | Specifies an Aurora Imaging Library metrology result buffer allocated using MmetAllocResult. |
M_MOD_GEOMETRIC | Specifies an Aurora Imaging Library Model Finder context allocated using MmodAlloc with M_GEOMETRIC. |
M_MOD_GEOMETRIC_CONTROLLED | Specifies an Aurora Imaging Library Model Finder context allocated using MmodAlloc with M_GEOMETRIC_CONTROLLED. |
M_MOD_RESULT | Specifies an Aurora Imaging Library Model Finder result buffer allocated using MmodAllocResult with M_DEFAULT. |
M_MOD_SHAPE_CIRCLE_CONTEXT | Specifies an Aurora Imaging Library Model Finder context allocated using MmodAlloc with M_SHAPE_CIRCLE. |
M_MOD_SHAPE_ELLIPSE_CONTEXT | Specifies an Aurora Imaging Library Model Finder context allocated using MmodAlloc with M_SHAPE_ELLIPSE. |
M_MOD_SHAPE_RECTANGLE_CONTEXT | Specifies an Aurora Imaging Library Model Finder context allocated using MmodAlloc with M_SHAPE_RECTANGLE. |
M_MOD_SHAPE_RESULT | Specifies an Aurora Imaging Library Model Finder result buffer allocated using MmodAllocResult with M_SHAPE_.... |
M_MOD_SHAPE_SEGMENT_CONTEXT | Specifies an Aurora Imaging Library Model Finder context allocated using MmodAlloc with M_SHAPE_SEGMENT. |
M_MUTEX | Specifies an Aurora Imaging Library mutex allocated using MthrAlloc with M_MUTEX. |
M_OCR_FONT | Specifies an Aurora Imaging Library character recognition font context allocated using MocrAllocFont. |
M_OCR_RESULT | Specifies an Aurora Imaging Library character recognition result buffer allocated using MocrAllocResult. |
M_PAT_CONTEXT | Specifies an Aurora Imaging Library pattern matching context allocated using MpatAlloc. |
M_PAT_RESULT | Specifies an Aurora Imaging Library pattern matching result buffer allocated using MpatAllocResult. |
M_REG_DFF_CONTEXT | Specifies an Aurora Imaging Library registration context allocated using MregAlloc with M_DEPTH_FROM_FOCUS. |
M_REG_DFF_RESULT | Specifies an Aurora Imaging Library registration result buffer allocated using MregAllocResult with M_DEPTH_FROM_FOCUS_RESULT. |
M_REG_EDOF_CONTEXT | Specifies an Aurora Imaging Library registration context allocated using MregAlloc with M_EXTENDED_DEPTH_OF_FIELD. |
M_REG_EDOF_RESULT | Specifies an Aurora Imaging Library registration result buffer allocated using MregAllocResult with M_EXTENDED_DEPTH_OF_FIELD_RESULT. |
M_REG_HDR_CONTEXT | Specifies an Aurora Imaging Library registration context allocated using MregAlloc with M_HIGH_DYNAMIC_RANGE. |
M_REG_HDR_RESULT | Specifies an Aurora Imaging Library registration result buffer allocated using MregAllocResult with M_HIGH_DYNAMIC_RANGE_RESULT. |
M_REG_PHOTOMETRIC_STEREO_CONTEXT | Specifies an Aurora Imaging Library registration context allocated using MregAlloc with M_PHOTOMETRIC_STEREO. |
M_REG_PHOTOMETRIC_STEREO_RESULT | Specifies an Aurora Imaging Library registration result buffer allocated using MregAllocResult with M_PHOTOMETRIC_STEREO_RESULT. |
M_REG_STITCHING_CONTEXT | Specifies an Aurora Imaging Library registration context allocated using MregAlloc with M_STITCHING. |
M_REG_STITCHING_RESULT | Specifies an Aurora Imaging Library registration result buffer allocated using MregAllocResult with M_STITCHING_RESULT. |
M_SELECTABLE_THREAD | Specifies an Aurora Imaging Library selectable thread allocated using MthrAlloc with M_SELECTABLE_THREAD. |
M_STR_CONTEXT | Specifies an Aurora Imaging Library string context allocated using MstrAlloc. |
M_STR_RESULT | Specifies an Aurora Imaging Library string result buffer allocated using MstrAllocResult. |
M_SYSTEM_THREAD | Specifies an Aurora Imaging Library thread allocated using MthrAlloc with M_THREAD. |
M_THREAD | Specifies an Aurora Imaging Library thread context object allocated using MthrAlloc with M_THREAD. |
M_USER_OBJECT_1 | Specifies an Aurora Imaging Library object from group one of the user-defined object types allocated using MfuncAllocId with M_USER_OBJECT_1. |
M_USER_OBJECT_2 | Specifies an Aurora Imaging Library object from group two of the user-defined object types allocated using MfuncAllocId with M_USER_OBJECT_2. |
M_CALL_CONTEXT | Specifies an Aurora Imaging Library function context for a current user-defined function. |
M_OBJECT_USER_DATA_PTR
Inquires the address of the user data to associate with the specified Aurora Imaging Library object. This is useful, for example, to associate specific data with the different buffers passed to MdigProcess. Note that when developing a Distributed Aurora Imaging Library 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 Aurora Imaging Library cluster that consists of two computers (A and B). If on computer A, you associate user data with a remote Aurora Imaging Library 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.
M_OWNER_SYSTEM
Inquires the Aurora Imaging Library identifier of the system on which the object has been allocated.
| Value | Description |
|---|---|
M_DEFAULT_HOST | Specifies the default Host system of the current Aurora Imaging Library application. |
System identifier | Specifies a valid system identifier, previously allocated using MsysAlloc. |
M_SYSTEM_LOCATION
Inquires whether the object is allocated on a local system or a DAIL remote system.
| Value | Description |
|---|---|
M_LOCAL | Specifies that the object is allocated on a local system. |
M_REMOTE | Specifies that the object is allocated on a remote system. |
Combination Constants — For distinguishing between the different object types
Essential.
Usage: You must add one of the following values 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).
| 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. |
For inquiring message mailbox settings
The following InquireType parameter settings can be specified for an Aurora Imaging Library message mailbox object allocated using MobjAllocwith M_MESSAGE_MAILBOX.
M_INIT_FLAG
Inquires the initialization of the allocated object.
| Value | Description |
|---|---|
M_DEFAULT | |
M_OVERWRITE | Specifies that only one message can be kept in the mailbox and is replaced at each write. |
M_QUEUE (default) | Specifies that multiple messages can be queued in the mailbox. |
M_MESSAGE_COUNT
Inquires the number of messages in the message mailbox.
| Value | Description |
|---|---|
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.
| Value | Description |
|---|---|
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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ERROR | Specifies that an Aurora Imaging Library error is generated when the message limit is attained. |
M_WRITE_TIMEOUT (default) | Specifies to wait for the write timeout to elapse. |
M_QUEUE_SIZE
Inquires the number of messages the queue can hold.
| Value | Description |
|---|---|
M_DEFAULT | |
Value > 0 (default) | Specifies the number of messages the queue can hold. |
M_READ_TIMEOUT
Inquires the amount of time to wait for a read operation.
| Value | Description |
|---|---|
M_DEFAULT | |
M_INFINITE (default) | 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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_INFINITE (default) | Specifies that the write operation waits indefinitely. |
Value > 0 | Specifies the amount of time to wait, in msecs. |
For inquiring HTTP server settings
The following InquireType parameter settings are used to inquire Aurora Imaging Library HTTP server objects allocated using MobjAllocwith M_HTTP_SERVER.
M_HTTP_ADDRESS
Inquires the web address (URL) with which the Aurora Imaging Library HTTP server can be accessed in a web browser. > Note: This setting requires Aurora Imaging Library driver update 47 (or later).
M_HTTP_PORT
Inquires the port on which the Aurora Imaging Library HTTP server listens for incoming connections. > Note: For increased security, you should ensure that remote computers cannot access this port from the internet/WAN. > Note: This setting requires Aurora Imaging Library driver update 47 (or later).
| Value | Description |
|---|---|
0 <= Value <=65535 (default) | Specifies the port number. |
M_HTTP_ROOT_DIRECTORY
Inquires the path to the folder on the local computer in which the files hosted by the Aurora Imaging Library HTTP server are stored. > Note: This setting requires Aurora Imaging Library driver update 47 (or later).
M_HTTP_STATE
Inquires whether the Aurora Imaging Library HTTP server is enabled.
| Value | Description |
|---|---|
M_HTTP_START | Specifies that the Aurora Imaging Library HTTP server is enabled. |
M_HTTP_STOP | Specifies that the Aurora Imaging Library HTTP server is disabled. |
Combination Constants — For getting the string size
Optional.
Usage: You can add one of the following values to the above-mentioned values to get the string's length.
M_STRING_SIZE
Retrieves the length of the string, including the terminating null character ("\0").
Return Value
Type: AIL_INT
The returned value is the requested information, cast to an AIL_INT. If the requested information does not fit into an AIL_INT, this function will return M_NULLor truncate the information.