MfuncParam

Board	Supported
Host System	Yes
V4L2	Yes
Clarity UHD	Yes
Concord PoE	No
GenTL	Yes
GevIQ	Yes
GigE Vision	Yes
Indio	No
Iris GTX	Yes
Radient eV-CL	Yes
Rapixo CL	Yes
Rapixo CoF	Yes
Rapixo CXP	Yes
USB3 Vision	Yes

Register a parameter.

Syntax

void MfuncParam(
    AIL_ID       ContextFuncId,  //in
    AIL_INT      ParamIndex,     //in
    const void * ParamValuePtr,  //in
    AIL_UINT     ParamType,      //in
    AIL_INT      NumOfItems,     //in
    AIL_INT64    AilObjectType,  //in
    AIL_INT      Attribute       //in
)

Description

This function allows you to register a parameter of any data type to the current user-defined Aurora Imaging Library function. The MfuncParam function should be called in the caller function after a call to MfuncAlloc and before a call to MfuncCall.

MfuncParam calls an explicitly named type-specific variation of this function. For example, to register an AIL_INT, it calls MfuncParamAilInt. Note that, for execution efficiency, you can call the appropriate, explicitly named, type-specific variation of MfuncParam directly. When registering parameters using the explicitly named type-specific variation of MfuncParam, you must use that function's specific signature, found below.

Parameters

`ContextFuncId` (in, AIL_ID)

Specifies the identifier of the user-defined Aurora Imaging Library function.

`ParamIndex` (in, AIL_INT)

Specifies the index of the parameter within the user-defined Aurora Imaging Library function's parameter list. The index of the first parameter is considered to be one.

`ParamValuePtr` (in, void)*

Specifies the address of the array or variable to register.

`ParamType` (in, AIL_UINT)

Specifies the parameter type of the parameter in the user-defined Aurora Imaging Library function. Parameter types include data types, arrays of data types, void pointers, strings, and file names.

`NumOfItems` (in, AIL_INT)

Specifies the size of the data pointed to by the ParamValuePtr parameter.

`AilObjectType` (in, AIL_INT64)

Specifies the type of the Aurora Imaging Library object when the data type of the parameter of the user-defined function is AIL_ID. The available object types are divided into two groups. When the specified object is of a type listed in the first group, you can specify a single or multiple object type(s) from this group. The object types of the second group cannot be used in combination with each other.

For specifying the type of Aurora Imaging Library object accepted by the Aurora Imaging Library identifier type parameter (one or multiple)

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` with`M_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`.

For specifying the type of Aurora Imaging Library object accepted by the Aurora Imaging Library identifier type parameter (only one)

Value	Description
`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 `McalAlloc`with `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 using`MclassAllocResult` with `M_PREDICT_ANO_RESULT`.
`M_CLASS_PREDICT_CNN_RESULT`	Specifies an Aurora Imaging Library CNN prediction result buffer, allocated using`MclassAllocResult` with `M_PREDICT_CNN_RESULT`.
`M_CLASS_PREDICT_DET_RESULT`	Specifies an Aurora Imaging Library object detection prediction result buffer, allocated using`MclassAllocResult` with `M_PREDICT_DET_RESULT`.
`M_CLASS_PREDICT_ONNX_RESULT`	Specifies an ONNX prediction result buffer, allocated using`MclassAllocResult` with `M_PREDICT_ONNX_RESULT`.
`M_CLASS_PREDICT_SEG_RESULT`	Specifies an Aurora Imaging Library segmentation prediction result buffer, allocated using`MclassAllocResult` with `M_PREDICT_SEG_RESULT`.
`M_CLASS_PREDICT_TREE_ENSEMBLE_RESULT`	Specifies an Aurora Imaging Library tree ensemble prediction result buffer, allocated using`MclassAllocResult` 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`.

For distinguishing between the different object types

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.

`Attribute` (in, AIL_INT)

Specifies whether the parameter will be used for data input or to store new data.

Parameter Associations

For registering a primitive data-type parameter in an Aurora Imaging Library user-defined function

The following values specify to call type-specific variations of MfuncParam that register parameters that handle primitive Aurora Imaging Library data types, such as, AIL_DOUBLE, AIL_INT, and AIL_UINT64, as well as strings, void pointers and file names. Unless otherwise specified, when specifying values from this table, you must set the NumOfItems parameter to M_DEFAULT, the AilObjectType parameter to M_NULL, and the Attribute parameter to M_NULL.

`M_PARAM_TYPE_AIL_DOUBLE`

Specifies to call MfuncParamAilDouble, which then registers a type AIL_DOUBLE parameter for the current user-defined Aurora Imaging Library function.

`M_PARAM_TYPE_AIL_INT`

Specifies to call MfuncParamAilInt, which then registers a type AIL_INT parameter for the current user-defined Aurora Imaging Library function.

`M_PARAM_TYPE_AIL_INT32`

Specifies to call MfuncParamAilInt32, which then registers a type AIL_INT32 parameter for the current user-defined Aurora Imaging Library function.

`M_PARAM_TYPE_AIL_INT64`

Specifies to call MfuncParamAilInt64, which then registers a type AIL_INT64 parameter for the current user-defined Aurora Imaging Library function.

`M_PARAM_TYPE_AIL_UINT`

Specifies to call MfuncParamAilUint, which then registers a type AIL_UINT parameter for the current user-defined Aurora Imaging Library function.

`M_PARAM_TYPE_AIL_UINT32`

Specifies to call MfuncParamAilUint32, which then registers a type AIL_UINT32 parameter for the current user-defined Aurora Imaging Library function.

`M_PARAM_TYPE_AIL_UINT64`

Specifies to call MfuncParamAilUint64, which then registers a type AIL_INT64 parameter for the current user-defined Aurora Imaging Library function.

For registering a primitive data-type array parameter in an Aurora Imaging Library user-defined function

The following values specify to call type-specific variations of MfuncParam that register parameters that handle arrays of primitive Aurora Imaging Library data types, such as, AIL_DOUBLE, AIL_INT, and AIL_UINT64. When specifying values from this table, you must set the NumOfItems parameter to the number of items in the array, and you must set the AilObjectType parameter to M_NULL.

`M_PARAM_TYPE_ARRAY_AIL_DOUBLE`

Specifies to call MfuncParamArrayAilDouble, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_DOUBLE.

Value	Description
`M_IN`
`M_OUT`

`M_PARAM_TYPE_ARRAY_AIL_INT`

Specifies to call MfuncParamArrayAilInt, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_INT.

Value	Description
`M_IN`
`M_OUT`

`M_PARAM_TYPE_ARRAY_AIL_INT32`

Specifies to call MfuncParamArrayAilInt32, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_INT32.

Value	Description
`M_IN`
`M_OUT`

`M_PARAM_TYPE_ARRAY_AIL_INT64`

Specifies to call MfuncParamArrayAilInt64, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_INT64.

Value	Description
`M_IN`
`M_OUT`

`M_PARAM_TYPE_ARRAY_AIL_UINT`

Specifies to call MfuncParamArrayAilUint, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_UINT.

Value	Description
`M_IN`
`M_OUT`

`M_PARAM_TYPE_ARRAY_AIL_UINT32`

Specifies to call MfuncParamArrayAilUint32, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_UINT32.

Value	Description
`M_IN`
`M_OUT`

`M_PARAM_TYPE_ARRAY_AIL_UINT64`

Specifies to call MfuncParamArrayAilUint64, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_UINT64.

Value	Description
`M_IN`
`M_OUT`

For registering a const array of primitive data-types parameter in an Aurora Imaging Library user-defined function

The following values specify to call type-specific variations of MfuncParam that register parameters that handle const arrays of primitive Aurora Imaging Library data types, such as, AIL_DOUBLE, AIL_INT, and AIL_UINT64, as well as const pointers and const strings. Unless otherwise specified, when specifying values from this table, you must set the NumOfItems parameter to the number of items in the array, and you must set the AilObjectType parameter to M_NULL.

`M_PARAM_TYPE_CONST_ARRAY_AIL_DOUBLE`

Specifies to call MfuncParamConstArrayAilDouble, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_DOUBLE.

Value	Description
`M_IN`

`M_PARAM_TYPE_CONST_ARRAY_AIL_INT`

Specifies to call MfuncParamConstArrayAilInt, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_INT.

Value	Description
`M_IN`

`M_PARAM_TYPE_CONST_ARRAY_AIL_INT32`

Specifies to call MfuncParamConstArrayAilInt32, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_INT32.

Value	Description
`M_IN`

`M_PARAM_TYPE_CONST_ARRAY_AIL_INT64`

Specifies to call MfuncParamConstArrayAilInt64, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_INT64.

Value	Description
`M_IN`

`M_PARAM_TYPE_CONST_ARRAY_AIL_UINT`

Specifies to call MfuncParamConstArrayAilUint, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_UINT.

Value	Description
`M_IN`

`M_PARAM_TYPE_CONST_ARRAY_AIL_UINT32`

Specifies to call MfuncParamConstArrayAilUint32, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_UINT32.

Value	Description
`M_IN`

`M_PARAM_TYPE_CONST_ARRAY_AIL_UINT64`

Specifies to call MfuncParamConstArrayAilUint64, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_UINT64.

Value	Description
`M_IN`

For registering a string or file name type parameter in an Aurora Imaging Library user-defined function

The following values specify to call type-specific variations of MfuncParam that register a string or file name parameter. Unless otherwise specified, when specifying values from this table, you must set the AilObjectType parameter to M_NULL.

`M_PARAM_TYPE_AIL_TEXT`

Specifies to call MfuncParamAilText, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a string.

Value	Description
`M_DEFAULT`	Specifies for Aurora Imaging Library to auto-calculate the number of characters in the string.
`Value`	Specifies the number of characters in the string.
`M_IN`
`M_OUT`

`M_PARAM_TYPE_CONST_AIL_TEXT`

Specifies to call MfuncParamConstAilText, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const string.

Value	Description
`M_DEFAULT`	Specifies for Aurora Imaging Library to auto-calculate the number of characters in the string.
`Value`	Specifies the number of characters in the string.
`M_IN`

`M_PARAM_TYPE_FILENAME`

Specifies to call MfuncParamFilename, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a file name.

Value	Description
`M_DEFAULT`	Specifies for Aurora Imaging Library to auto-calculate the number of characters in the string.
`Value`	Specifies the number of characters in the string.
`M_IN`	Specifies that the parameter of the current user-defined Aurora Imaging Library function will be registered for file reading only.
`M_OUT`	Specifies that the parameter of the current user-defined Aurora Imaging Library function will be registered for file writing only.

For registering a pointer type parameter in an Aurora Imaging Library user-defined function

The following values specify to call type-specific variations of MfuncParam that register pointer parameters, including arrays and const arrays of pointers. Unless otherwise specified, when specifying values from this table, you must set the AilObjectType parameter to M_NULL.

`M_PARAM_TYPE_CONST_DATA_PTR`

Specifies to call MfuncParamConstDataPointer, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const data pointer.

Value	Description
`M_IN`

`M_PARAM_TYPE_DATA_PTR`

Specifies to call MfuncParamDataPointer, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a data pointer.

Value	Description
`M_IN`
`M_OUT`	Specifies that the object passed to `ParamValuePtr` is used to store new data from the user-defined function.

For registering an Aurora Imaging Library identifier type parameter in an Aurora Imaging Library user-defined function

The following values specify to call type-specific variations of MfuncParam that register parameters that handle an AIL_ID, including arrays and const arrays of _AIL_ID_s. When registering AIL_ID parameters, you must specify a value for AilObjectType.

`M_PARAM_TYPE_AIL_ID`

Specifies to call MfuncParamAilId, which then registers a type AIL_ID parameter of the current user-defined Aurora Imaging Library function.

Value	Description
`M_IN`	Specifies that the object referenced by the AIL_ID passed to `ParamValuePtr` is used for data input.
`M_OUT`	Specifies that the object referenced by the AIL_ID passed to `ParamValuePtr` is used to store new data from the user-defined function.

`M_PARAM_TYPE_ARRAY_AIL_ID`

Specifies to call MfuncParamArrayAilId, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles an array of type AIL_ID.

Value	Description
`M_IN`	Specifies that the objects referenced in the array passed to `ParamValuePtr` are used for data input.
`M_OUT`	Specifies that the objects referenced by the AIL_ID passed to `ParamValuePtr` are used to store new data from the user-defined function.

`M_PARAM_TYPE_CONST_ARRAY_AIL_ID`

Specifies to call MfuncParamConstArrayAilId, which then registers a parameter of the current user-defined Aurora Imaging Library function that handles a const array of type AIL_ID.

Value	Description
`M_IN`	Specifies that the objects referenced in the array passed to `ParamValuePtr` are used for data input.

Combination Constants — For specifying optional settings for an Aurora Imaging Library identifier type parameter

Optional.

Usage: You can add one or more of the following values to the above-mentioned values to specify the optional settings for an Aurora Imaging Library identifier type parameter.

When you register an Aurora Imaging Library identifier type of parameter, the user-defined function will throw an error if a value other than an AIL_ID is passed to it. There are, however, non-standard identifier values that can be accepted. The values specified below specify which non-standard identifier values are valid in addition to an AIL_ID. There is also the optional of specifying that an Aurora Imaging Library identifier will not be internally modified or compensated during the execution of the user-defined function.

Value	Description
`M_ALLOW_DEFAULT_ID`	Specifies that this parameter will accept M_DEFAULT as a valid AIL_ID.
`M_ALLOW_NULL_ID`	Specifies that this parameter will accept M_NULL as a valid AIL_ID.
`M_AS_VALUE`	Specifies that this parameter will accept any valid AIL_ID, but will not internally modify it. This means different things depending on if this value is added to `M_IN` or `M_OUT`. For an Aurora Imaging Library identifier type parameter set to `M_IN`, the buffer specified by the user is used as the source of information for the user-defined function. When that source buffer is on a different system, the Aurora Imaging Library identifier for that buffer is internally modified if the content of the buffer needs to be copied to another system for processing. This modification is called compensation. If your application uses the Aurora Imaging Library identifiers exactly as specified by the user, your application could crash by inadvertently pointing to a buffer whose content has been copied to another buffer with a compensated Aurora Imaging Library identifier. You can avoid this by adding `M_AS_VALUE` to `M_IN` when registering your parameter. This has the effect of keeping the specific value of the Aurora Imaging Library identifier specified by the user, without compensating it. For an Aurora Imaging Library identifier type parameter set to `M_OUT`, the buffer specified by the user is used as the destination of information for the user-defined function. When you register this parameter without `M_AS_VALUE`, the user must specify the AIL_ID of a previously allocated buffer. When the user-defined function is called, the content of that destination buffer will be filled with new data. When you register this parameter as `M_OUT` + `M_AS_VALUE`, the user must specify a pointer. When the user-defined function is called, the pointer will be filled with an AIL_ID. The AIL_ID could be, for example, a newly-allocated buffer or the result of an inquire.

Combination Constants — For specifying the type of image buffer when the

Optional.

Usage: You can add one or more of the following values to the above-mentioned values to specify the image buffer type, if AilObjectType is set to M_IMAGE.

If you specify an M_IMAGE object (from the ParamValuePtr parameter) that does not correspond to any of the type(s) selected from the values listed below, an error is returned. If none of the values specified below are added, any M_IMAGE object will be accepted. Note that you cannot specify any of the following if the AilObjectType parameter is set to a combination of values.

Value	Description
`M_DISP`	Specifies that the buffer can be displayed.
`M_GRAB`	Specifies that the buffer can have data grabbed into it.
`M_PROC`	Specifies that the buffer can be processed.

This parameter should be set to one or both (M_IN + M_OUT) of the following values.

Specifies that the object passed to ParamValuePtr is used for data input.

Specifies that the array passed to ParamValuePtr is used for data input.

Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.

Syntax
Description
Parameters
Parameter Associations

Syntax​

Description​

Parameters​

ContextFuncId (in, AIL_ID)​

ParamIndex (in, AIL_INT)​

ParamValuePtr *(in, void)​

ParamType (in, AIL_UINT)​

NumOfItems (in, AIL_INT)​

AilObjectType (in, AIL_INT64)​

Attribute (in, AIL_INT)​

Parameter Associations​

For registering a primitive data-type parameter in an Aurora Imaging Library user-defined function​

M_PARAM_TYPE_AIL_DOUBLE​

M_PARAM_TYPE_AIL_INT​

M_PARAM_TYPE_AIL_INT32​

M_PARAM_TYPE_AIL_INT64​

M_PARAM_TYPE_AIL_UINT​

M_PARAM_TYPE_AIL_UINT32​

M_PARAM_TYPE_AIL_UINT64​

For registering a primitive data-type array parameter in an Aurora Imaging Library user-defined function​

M_PARAM_TYPE_ARRAY_AIL_DOUBLE​

M_PARAM_TYPE_ARRAY_AIL_INT​

M_PARAM_TYPE_ARRAY_AIL_INT32​

M_PARAM_TYPE_ARRAY_AIL_INT64​

M_PARAM_TYPE_ARRAY_AIL_UINT​

M_PARAM_TYPE_ARRAY_AIL_UINT32​

M_PARAM_TYPE_ARRAY_AIL_UINT64​

For registering a const array of primitive data-types parameter in an Aurora Imaging Library user-defined function​

M_PARAM_TYPE_CONST_ARRAY_AIL_DOUBLE​

M_PARAM_TYPE_CONST_ARRAY_AIL_INT​

M_PARAM_TYPE_CONST_ARRAY_AIL_INT32​

M_PARAM_TYPE_CONST_ARRAY_AIL_INT64​

M_PARAM_TYPE_CONST_ARRAY_AIL_UINT​

M_PARAM_TYPE_CONST_ARRAY_AIL_UINT32​

M_PARAM_TYPE_CONST_ARRAY_AIL_UINT64​

For registering a string or file name type parameter in an Aurora Imaging Library user-defined function​

M_PARAM_TYPE_AIL_TEXT​

M_PARAM_TYPE_CONST_AIL_TEXT​

M_PARAM_TYPE_FILENAME​

For registering a pointer type parameter in an Aurora Imaging Library user-defined function​

M_PARAM_TYPE_CONST_DATA_PTR​

M_PARAM_TYPE_DATA_PTR​

For registering an Aurora Imaging Library identifier type parameter in an Aurora Imaging Library user-defined function​

M_PARAM_TYPE_AIL_ID​

M_PARAM_TYPE_ARRAY_AIL_ID​

M_PARAM_TYPE_CONST_ARRAY_AIL_ID​

Combination Constants — For specifying optional settings for an Aurora Imaging Library identifier type parameter​

Combination Constants — For specifying the type of image buffer when the​