MfuncParam

See also

User Guide:

Associating a MIL identifier with a user-defined object Parameter registration and return values Script-based user-defined MIL function Steps to create a user-defined MIL function

Reference:

M3ddispAlloc M3dgeoAlloc M3dgraAlloc M3dimAlloc M3dimAllocResult M3dimCalculateMapSize M3dimFillGaps M3dimMesh M3dimNormals M3dimSample M3dimStat M3dmapAlloc M3dmapAllocResult M3dmetAlloc M3dmetAllocResult M3dregAlloc M3dregAllocResult MappAlloc MbeadAlloc MbeadAllocResult MblobAlloc MblobAllocResult MbufAlloc2d MbufAllocColor MbufAllocContainer McalAlloc MclassAlloc MclassAllocResult MclassPredict MclassTrain McodeAllocResult McodeModel McolAlloc McolAllocResult McomAlloc MdigAlloc MdispAlloc MdmrAlloc MdmrAllocResult MedgeAlloc MedgeAllocResult MfuncAlloc MfuncAllocId MfuncCall MgraAlloc MgraAllocList MimAlloc MimAllocResult MimStatCalculate MmeasAllocContext MmeasAllocMarker MmeasAllocResult MmetAlloc MmetAllocResult MmodAlloc MmodAllocResult MobjAlloc MocrAllocFont MocrAllocResult MpatAlloc MpatAllocResult MregAlloc MregAllocResult MseqAlloc MstrAlloc MstrAllocResult MsysAlloc MsysIoAlloc MthrAlloc

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

None.

Function Map

Table:	For specifying the type of MIL object accepted by the MIL identifier type parameter (one or multiple)
Table:	For specifying the type of MIL object accepted by the MIL identifier type parameter (only one)
+ combination:	For distinguishing between the different object types

- Attribute

Parameter Associations

Table:	For registering a primitive data-type parameter in a MIL user-defined function
Table:	For registering a primitive data-type array parameter in a MIL user-defined function
Table:	For registering a const array of primitive data-types parameter in a MIL user-defined function
Table:	For registering a string or file name type parameter in a MIL user-defined function
Table:	For registering a pointer type parameter in a MIL user-defined function
Table:	For registering a MIL identifier type parameter in a MIL user-defined function
+ combination:	For specifying optional settings for a MIL identifier type parameter
+ combination:	For specifying the type of image buffer when the MilObjectType is set to M_IMAGE

Type-specific versions of the function

Compilation information

Synopsis

Syntax

void MfuncParam(

MIL_ID ContextFuncId,	//in
MIL_INT ParamIndex,	//in
const void *ParamValuePtr,	//in
MIL_UINT ParamType,	//in
MIL_INT NumOfItems,	//in
MIL_INT64 MilObjectType,	//in
MIL_INT Attribute	//in

)

Description

This function allows you to register a parameter of any data type to the current user-defined MIL function. The MfuncParam() function should be called in the master 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 a MIL_INT, it calls MfuncParamMilInt(). 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.

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 which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

ContextFuncId

Specifies the identifier of the user-defined MIL function.

ParamIndex

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

ParamValuePtr

Specifies the address of the array or variable to register.

Note that for non-arrays, you must pass a reference to the variable. For arrays, you just pass the array name.

ParamType

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

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

NumOfItems

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

When the data is an array, the size is the number of elements. When the data is a string, the size is the number of characters in the string. When the data is a pointer, the size is in bytes. For all other types of data, set this parameter to M_DEFAULT.

This value must be greater than 0 in all cases other than M_DEFAULT.

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

MilObjectType

Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_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.

When the data type of the parameter of the user-defined function is not MIL_ID or an array of MIL_ID s, set MilObjectType to M_NULL.

The following value specifies the type of MIL objects that the MIL identifier type parameter will accept. Any value in this table can be combined with one or more values in this table. For example, if the MIL object is expected to be of type M_ARRAY or M_COUNT_LIST, set the MilObjectType parameter to M_ARRAY + M_COUNT_LIST.

For specifying the type of MIL object accepted by the MIL identifier type parameter (one or multiple)
Value	Description
M_APPLICATION	Specifies a MIL application context allocated using MappAlloc().
M_ARRAY	Specifies a MIL array buffer allocated using MbufAlloc2d() with M_ARRAY.
M_AUGMENTATION_RESULT	Specifies a MIL augmentation result buffer allocated using MimAllocResult() with M_AUGMENTATION_RESULT.
M_CONTAINER	Specifies a MIL container buffer allocated using MbufAllocContainer().
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_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 2D graphics context allocated using MgraAlloc().
M_GRAPHIC_LIST	Specifies a MIL 2D graphics list allocated using MgraAllocList().
M_HIST_LIST	Specifies a MIL 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 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_MESSAGE_MAILBOX	Specifies a MIL message mailbox allocated using MobjAlloc().
M_PROJ_LIST	Specifies a MIL project list result buffer allocated using MimAllocResult() with M_PROJ_LIST.
M_SEQUENCE_CONTEXT	Specifies a MIL sequence context allocated using MseqAlloc().
M_STATISTICS_RESULT	Specifies a MIL MimStatCalculate() result buffer allocated using MimAllocResult() with M_STATISTICS_RESULT.
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_WAVELET_TRANSFORM_RESULT	Specifies a MIL wavelet transform result buffer allocated using MimAllocResult() with M_WAVELET_TRANSFORM_RESULT.

The following value specifies the type of MIL objects that the MIL identifier type parameter will accept. No value in this table can be combined with any other value in this table, though a value in this table can be combined with one or more values from the above table.

For specifying the type of MIL object accepted by the MIL identifier type parameter (only one)
Value	Description
M_3D_DISPLAY	Specifies a MIL 3D display allocated using M3ddispAlloc().
M_3D_GRAPHIC_LIST	Specifies a MIL 3D graphics list allocated using M3dgraAlloc().
M_3DGEO_GEOMETRY	Specifies a MIL 3D geometry object allocated using M3dgeoAlloc() with M_GEOMETRY.
M_3DGEO_TRANSFORMATION_MATRIX	Specifies a MIL 3D transformation matrix object allocated using M3dgeoAlloc() with M_TRANSFORMATION_MATRIX.
M_3DIM_CALCULATE_MAP_SIZE_CONTEXT	Specifies a MIL 3D image processing context that can be used with M3dimCalculateMapSize(), allocated using M3dimAlloc() with M_CALCULATE_MAP_SIZE_CONTEXT.
M_3DIM_FILL_GAPS_CONTEXT	Specifies a MIL 3D image processing context that can be used with M3dimFillGaps(), allocated using M3dimAlloc() with M_FILL_GAPS_CONTEXT.
M_3DIM_MESH_CONTEXT	Specifies a MIL 3D image processing context that can be used with M3dimMesh(), allocated using M3dimAlloc() with M_MESH_CONTEXT.
M_3DIM_NORMALS_CONTEXT	Specifies a MIL 3D image processing context that can be used with M3dimNormals(), allocated using M3dimAlloc() with M_NORMALS_CONTEXT.
M_3DIM_PROFILE_RESULT	Specifies a MIL 3D image processing result buffer for profile results, allocated using M3dimAllocResult() with M_PROFILE_RESULT.
M_3DIM_STATISTICS_CONTEXT	Specifies a MIL 3D image processing context that can be used with M3dimStat(), allocated using M3dimAlloc() with M_STATISTICS_CONTEXT.
M_3DIM_STATISTICS_RESULT	Specifies a MIL 3D image processing result buffer used to store M3dimStat() results, and is allocated using M3dimAllocResult() with M_STATISTICS_RESULT.
M_3DIM_SUBSAMPLE_CONTEXT	Specifies a MIL 3D image processing context that can be used with M3dimSample(), allocated using M3dimAlloc() with M_SUBSAMPLE_CONTEXT.
M_3DIM_SURFACE_SAMPLE_CONTEXT	Specifies a MIL 3D image processing context that can be used with M3dimSample(), allocated using M3dimAlloc() with M_SURFACE_SAMPLE_CONTEXT.
M_3DMAP_DEPTH_CORRECTED_DATA	Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_DEPTH_CORRECTED_DATA.
M_3DMAP_DRAW_3D_CONTEXT	Specifies a MIL 3D draw context allocated using M3dmapAlloc() with M_DRAW_3D_CONTEXT.
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_POINT_CLOUD_RESULT	Specifies a MIL 3D reconstruction result buffer allocated using M3dmapAllocResult() with M_POINT_CLOUD_RESULT.
M_3DMET_FIT_CONTEXT	Specifies a MIL fit 3D metrology context allocated using M3dmetAlloc() with M_FIT_CONTEXT.
M_3DMET_FIT_RESULT	Specifies a MIL fit 3D metrology result buffer allocated using M3dmetAllocResult() with M_FIT_RESULT.
M_3DMET_STATISTICS_CONTEXT	Specifies a MIL statistics 3D metrology context allocated using M3dmetAlloc() with M_STATISTICS_CONTEXT.
M_3DMET_STATISTICS_RESULT	Specifies a MIL statistics 3D metrology result buffer allocated using M3dmetAllocResult() with M_STATISTICS_RESULT.
M_3DREG_PAIRWISE_REGISTRATION_CONTEXT	Specifies a MIL pairwise 3D registration context allocated using M3dregAlloc() with M_PAIRWISE_REGISTRATION_CONTEXT.
M_3DREG_PAIRWISE_REGISTRATION_RESULT	Specifies a MIL pairwise 3D registration result buffer allocated using M3dregAllocResult() with M_PAIRWISE_REGISTRATION_RESULT.
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_DRAW_3D_CONTEXT	Specifies a MIL 3D draw calibration context allocated using McalAlloc() with M_DRAW_3D_CONTEXT.
M_CAL_FIXTURING_OFFSET	Specifies a MIL fixturing offset object allocated using McalAlloc() with M_FIXTURING_OFFSET.
M_CLASS_CLASSIFIER_CNN_PREDEFINED_CONTEXT	Specifies a MIL predefined convolutional neural network context allocated using MclassAlloc().
M_CLASS_CLASSIFIER_TREE_ENSEMBLE_CONTEXT	Specifies a MIL tree ensemble classifier context allocated using MclassAlloc().
M_CLASS_DATASET_FEATURES	Specifies a MIL features dataset context allocated using MclassAlloc() with M_DATASET_FEATURES.
M_CLASS_DATASET_IMAGES	Specifies a MIL classification dataset allocated using MclassAlloc().
M_CLASS_PREDICT_CNN_RESULT	Specifies a MIL result buffer to hold the classification results performed with a predefined convolutional neural network context using MclassPredict(). Allocated using MclassAllocResult(). (summarize) Specifies a MIL result buffer to hold the classification results performed with a predefined convolutional neural network context using MclassPredict(). (more details...)
M_CLASS_PREDICT_TREE_ENSEMBLE_RESULT	Specifies a MIL tree ensemble prediction result buffer, allocated using MclassAllocResult().
M_CLASS_TRAIN_CNN_CONTEXT	Specifies a MIL context to hold the training settings of a convolutional neural network training context allocated using MclassAlloc().
M_CLASS_TRAIN_CNN_RESULT	Specifies a MIL result buffer to hold the result of a call to MclassTrain().
M_CLASS_TRAIN_TREE_ENSEMBLE_CONTEXT	Specifies a MIL tree ensemble training context, allocated using MclassAlloc().
M_CLASS_TRAIN_TREE_ENSEMBLE_RESULT	Specifies a MIL tree ensemble training result buffer, allocated using MclassAlloc().
M_CODE_CONTEXT	Specifies a MIL code context allocated using McolAlloc().
M_CODE_DETECT_RESULT	Specifies a MIL code detect result buffer allocated using McodeAllocResult().
M_CODE_GRADE_RESULT	Specifies a MIL code grade result buffer allocated using McodeAllocResult().
M_CODE_MODEL	Specifies a MIL code model allocated using McodeModel() with M_ADD.
M_CODE_READ_RESULT	Specifies a MIL code read result buffer allocated using McodeAllocResult().
M_CODE_TRAIN_RESULT	Specifies a MIL code train result buffer allocated using McodeAllocResult().
M_CODE_WRITE_RESULT	Specifies a MIL code write 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_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_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_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_CIRCLE_CONTEXT	Specifies a MIL Model Finder context allocated using MmodAlloc() with M_SHAPE_CIRCLE.
M_MOD_SHAPE_ELLIPSE_CONTEXT	Specifies a MIL Model Finder context allocated using MmodAlloc() with M_SHAPE_ELLIPSE.
M_MOD_SHAPE_RECTANGLE_CONTEXT	Specifies a MIL Model Finder context allocated using MmodAlloc() with M_SHAPE_RECTANGLE.
M_MOD_SHAPE_RESULT	Specifies a MIL Model Finder result buffer allocated using MmodAllocResult() with M_SHAPE_CIRCLE or M_SHAPE_ELLIPSE.
M_MOD_SHAPE_SEGMENT_CONTEXT	Specifies a MIL Model Finder context allocated using MmodAlloc() with M_SHAPE_SEGMENT.
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_REG_DFF_CONTEXT	Specifies a MIL registration context allocated using MregAlloc() with M_DEPTH_FROM_FOCUS.
M_REG_DFF_RESULT	Specifies a MIL registration result buffer allocated using MregAllocResult() with M_DEPTH_FROM_FOCUS_RESULT.
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_HDR_CONTEXT	Specifies a MIL registration context allocated using MregAlloc() with M_HIGH_DYNAMIC_RANGE.
M_REG_HDR_RESULT	Specifies a MIL registration result buffer allocated using MregAllocResult() with M_HIGH_DYNAMIC_RANGE_RESULT.
M_REG_PHOTOMETRIC_STEREO_CONTEXT	Specifies a MIL registration context allocated using MregAlloc() with M_PHOTOMETRIC_STEREO.
M_REG_PHOTOMETRIC_STEREO_RESULT	Specifies a MIL registration result buffer allocated using MregAllocResult() with M_PHOTOMETRIC_STEREO_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_STR_CONTEXT	Specifies a MIL string context allocated using MstrAlloc().
M_STR_RESULT	Specifies a MIL string result buffer allocated using MstrAllocResult().
M_SYSTEM_THREAD	Specifies a MIL thread allocated using MthrAlloc() with M_THREAD.
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. You must specify a combination 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. You must specify a combination 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...)

Combination value for M_USER_OBJECT_1; M_USER_OBJECT_2.

You must add the following value to the above-mentioned values to set the offset.

The offset allows you to distinguish between the different object types of the same group (for example, M_USER_OBJECT_1 + 0x0001).

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

Attribute

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

When registering a const array type parameter, Attribute must be set to M_IN.

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

Parameter associations

The tables below list possible values for the ParamType, NumOfItems, and Attribute parameters.

For registering a primitive data-type parameter in a MIL user-defined function
For registering a primitive data-type array parameter in a MIL user-defined function
For registering a const array of primitive data-types parameter in a MIL user-defined function
For registering a string or file name type parameter in a MIL user-defined function
For registering a pointer type parameter in a MIL user-defined function
For registering a MIL identifier type parameter in a MIL user-defined function

The following values specify to call type-specific variations of MfuncParam() that register parameters that handle primitive MIL data types, such as, MIL_DOUBLE, MIL_INT, and MIL_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 MilObjectType parameter to M_NULL, and the Attribute parameter to M_NULL.

For registering a primitive data-type parameter in a MIL user-defined function
ParamType		Description
	NumOfItems
	Attribute
M_PARAM_TYPE_MIL_DOUBLE		Specifies to call MfuncParamMilDouble(), which then registers a type MIL_DOUBLE parameter for the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilDouble(), which then registers a type MIL_DOUBLE parameter for the current user-defined MIL function. (more details...)
M_PARAM_TYPE_MIL_INT		Specifies to call MfuncParamMilInt(), which then registers a type MIL_INT parameter for the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilInt(), which then registers a type MIL_INT parameter for the current user-defined MIL function. (more details...)
M_PARAM_TYPE_MIL_INT32		Specifies to call MfuncParamMilInt32(), which then registers a type MIL_INT32 parameter for the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilInt32(), which then registers a type MIL_INT32 parameter for the current user-defined MIL function. (more details...)
M_PARAM_TYPE_MIL_INT64		Specifies to call MfuncParamMilInt64(), which then registers a type MIL_INT64 parameter for the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilInt64(), which then registers a type MIL_INT64 parameter for the current user-defined MIL function. (more details...)
M_PARAM_TYPE_MIL_UINT		Specifies to call MfuncParamMilUint(), which then registers a type MIL_UINT parameter for the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilUint(), which then registers a type MIL_UINT parameter for the current user-defined MIL function. (more details...)
M_PARAM_TYPE_MIL_UINT32		Specifies to call MfuncParamMilUint32(), which then registers a type MIL_UINT32 parameter for the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilUint32(), which then registers a type MIL_UINT32 parameter for the current user-defined MIL function. (more details...)
M_PARAM_TYPE_MIL_UINT64		Specifies to call MfuncParamMilUint64(), which then registers a type MIL_INT64 parameter for the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilUint64(), which then registers a type MIL_INT64 parameter for the current user-defined MIL function. (more details...)

The following values specify to call type-specific variations of MfuncParam() that register parameters that handle arrays of primitive MIL data types, such as, MIL_DOUBLE, MIL_INT, and MIL_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 MilObjectType parameter to M_NULL.

For registering a primitive data-type array parameter in a MIL user-defined function
ParamType			Description
	NumOfItems
	Attribute
M_PARAM_TYPE_ARRAY_MIL_DOUBLE			Specifies to call MfuncParamArrayMilDouble(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_DOUBLE. (summarize) Specifies to call MfuncParamArrayMilDouble(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_DOUBLE. (more details...)
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.
M_PARAM_TYPE_ARRAY_MIL_INT			Specifies to call MfuncParamArrayMilInt(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_INT. (summarize) Specifies to call MfuncParamArrayMilInt(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_INT. (more details...)
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.
M_PARAM_TYPE_ARRAY_MIL_INT32			Specifies to call MfuncParamArrayMilInt32(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_INT32. (summarize) Specifies to call MfuncParamArrayMilInt32(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_INT32. (more details...)
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.
M_PARAM_TYPE_ARRAY_MIL_INT64			Specifies to call MfuncParamArrayMilInt64(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_INT64. (summarize) Specifies to call MfuncParamArrayMilInt64(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_INT64. (more details...)
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.
M_PARAM_TYPE_ARRAY_MIL_UINT			Specifies to call MfuncParamArrayMilUint(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_UINT. (summarize) Specifies to call MfuncParamArrayMilUint(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_UINT. (more details...)
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.
M_PARAM_TYPE_ARRAY_MIL_UINT32			Specifies to call MfuncParamArrayMilUint32(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_UINT32. (summarize) Specifies to call MfuncParamArrayMilUint32(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_UINT32. (more details...)
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.
M_PARAM_TYPE_ARRAY_MIL_UINT64			Specifies to call MfuncParamArrayMilUint64(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_UINT64. (summarize) Specifies to call MfuncParamArrayMilUint64(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_UINT64. (more details...)
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the user-defined function.

The following values specify to call type-specific variations of MfuncParam() that register parameters that handle const arrays of primitive MIL data types, such as, MIL_DOUBLE, MIL_INT, and MIL_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 MilObjectType parameter to M_NULL.

For registering a const array of primitive data-types parameter in a MIL user-defined function
ParamType			Description
	NumOfItems
	Attribute
M_PARAM_TYPE_CONST_ARRAY_MIL_DOUBLE			Specifies to call MfuncParamConstArrayMilDouble(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_DOUBLE. (summarize) Specifies to call MfuncParamConstArrayMilDouble(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_DOUBLE. (more details...)
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_CONST_ARRAY_MIL_INT			Specifies to call MfuncParamConstArrayMilInt(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_INT. (summarize) Specifies to call MfuncParamConstArrayMilInt(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_INT. (more details...)
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_CONST_ARRAY_MIL_INT32			Specifies to call MfuncParamConstArrayMilInt32(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_INT32. (summarize) Specifies to call MfuncParamConstArrayMilInt32(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_INT32. (more details...)
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_CONST_ARRAY_MIL_INT64			Specifies to call MfuncParamConstArrayMilInt64(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_INT64. (summarize) Specifies to call MfuncParamConstArrayMilInt64(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_INT64. (more details...)
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT			Specifies to call MfuncParamConstArrayMilUint(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_UINT. (summarize) Specifies to call MfuncParamConstArrayMilUint(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_UINT. (more details...)
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT32			Specifies to call MfuncParamConstArrayMilUint32(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_UINT32. (summarize) Specifies to call MfuncParamConstArrayMilUint32(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_UINT32. (more details...)
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT64			Specifies to call MfuncParamConstArrayMilUint64(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_UINT64. (summarize) Specifies to call MfuncParamConstArrayMilUint64(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_UINT64. (more details...)
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.

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 MilObjectType parameter to M_NULL.

For registering a string or file name type parameter in a MIL user-defined function
ParamType			Description
	NumOfItems
	Attribute
M_PARAM_TYPE_CONST_MIL_TEXT			Specifies to call MfuncParamConstMilText(), which then registers a parameter of the current user-defined MIL function that handles a const string. (summarize) Specifies to call MfuncParamConstMilText(), which then registers a parameter of the current user-defined MIL function that handles a const string. (more details...)
	NumOfItems		Specifies one of the following. (summarize) Specifies one of the following. (more details...)
		M_DEFAULT	Specifies for MIL to auto-calculate the number of characters in the string.
		Value	Specifies the number of characters in the string.
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the object passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_FILENAME			Specifies to call MfuncParamFilename(), which then registers a parameter of the current user-defined MIL function that handles a file name. (summarize) Specifies to call MfuncParamFilename(), which then registers a parameter of the current user-defined MIL function that handles a file name. (more details...)
	NumOfItems		Specifies one of the following. (summarize) Specifies one of the following. (more details...)
		M_DEFAULT	Specifies for MIL to auto-calculate the number of characters in the string.
		Value	Specifies the number of characters in the string.
	Attribute		Specifies one of the following. (summarize) Specifies one of the following. (more details...)
		M_IN	Specifies that the parameter of the current user-defined MIL function will be registered for file reading only.
		M_OUT	Specifies that the parameter of the current user-defined MIL function will be registered for file writing only.
M_PARAM_TYPE_MIL_TEXT			Specifies to call MfuncParamMilText(), which then registers a parameter of the current user-defined MIL function that handles a string. (summarize) Specifies to call MfuncParamMilText(), which then registers a parameter of the current user-defined MIL function that handles a string. (more details...)
	NumOfItems		Specifies one of the following. (summarize) Specifies one of the following. (more details...)
		M_DEFAULT	Specifies for MIL to auto-calculate the number of characters in the string.
		Value	Specifies the number of characters in the string.
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the array passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the array passed to ParamValuePtr is used to store new data from the 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 MilObjectType parameter to M_NULL.

For registering a pointer type parameter in a MIL user-defined function
ParamType			Description
	NumOfItems
	Attribute
M_PARAM_TYPE_CONST_DATA_PTR			Specifies to call MfuncParamConstDataPointer(), which then registers a parameter of the current user-defined MIL function that handles a const data pointer. (summarize) Specifies to call MfuncParamConstDataPointer(), which then registers a parameter of the current user-defined MIL function that handles a const data pointer. (more details...)
	NumOfItems		Specifies the number of bytes in the pointer.
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the object passed to ParamValuePtr is used for data input.
M_PARAM_TYPE_DATA_PTR			Specifies to call MfuncParamDataPointer(), which then registers a parameter of the current user-defined MIL function that handles a data pointer. (summarize) Specifies to call MfuncParamDataPointer(), which then registers a parameter of the current user-defined MIL function that handles a data pointer. (more details...)
	NumOfItems		Specifies the number of bytes in the pointer.
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the object passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the object passed to ParamValuePtr is used to store new data from the user-defined function.

The following values specify to call type-specific variations of MfuncParam() that register parameters that handle a MIL_ID, including arrays and const arrays of MIL_ID s.

When registering MIL_ID parameters, you must specify a value for MilObjectType.

For registering a MIL identifier type parameter in a MIL user-defined function
ParamType			Description
	NumOfItems
	Attribute
M_PARAM_TYPE_ARRAY_MIL_ID +			Specifies to call MfuncParamArrayMilId(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_ID. (summarize) Specifies to call MfuncParamArrayMilId(), which then registers a parameter of the current user-defined MIL function that handles an array of type MIL_ID. (more details...)
	NumOfItems		Specify the number of elements in the array.
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		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 MIL_ID passed to ParamValuePtr are used to store new data from the user-defined function.
M_PARAM_TYPE_CONST_ARRAY_MIL_ID +			Specifies to call MfuncParamConstArrayMilId(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_ID. (summarize) Specifies to call MfuncParamConstArrayMilId(), which then registers a parameter of the current user-defined MIL function that handles a const array of type MIL_ID. (more details...)
	NumOfItems		Specify the number of elements in the array.
	Attribute		Specifies the following. (summarize) Specifies the following. (more details...)
		M_IN	Specifies that the objects referenced in the array passed to ParamValuePtr are used for data input.
M_PARAM_TYPE_MIL_ID +			Specifies to call MfuncParamMilId(), which then registers a type MIL_ID parameter of the current user-defined MIL function. (summarize) Specifies to call MfuncParamMilId(), which then registers a type MIL_ID parameter of the current user-defined MIL function. (more details...)
	NumOfItems		This parameter must be set to M_DEFAULT.
	Attribute		This parameter should be set to one or both (M_IN + M_OUT) of the following values. (summarize) This parameter should be set to one or both (M_IN + M_OUT) of the following values. (more details...)
		M_IN	Specifies that the object referenced by the MIL_ID passed to ParamValuePtr is used for data input.
		M_OUT	Specifies that the object referenced by the MIL_ID passed to ParamValuePtr is used to store new data from the user-defined function.

Combination values for the values listed in For registering a MIL identifier type parameter in a MIL user-defined function.

You can add one or more of the following values to the above-mentioned values to specify the optional settings for a MIL identifier type parameter.

When you register a MIL identifier type of parameter, the user-defined function will throw an error if a value other than a MIL_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 a MIL_ID.

There is also the optional of specifying that a MIL identifier will not be internally modified or compensated during the execution of the user-defined function.

For specifying optional settings for a MIL identifier type parameter
Combination value	Description
M_ALLOW_DEFAULT_ID	Specifies that this parameter will accept M_DEFAULT as a valid MIL_ID.
M_ALLOW_NULL_ID	Specifies that this parameter will accept M_NULL as a valid MIL_ID.
M_AS_VALUE	Specifies that this parameter will accept any valid MIL_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 a MIL 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 MIL 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 MIL 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 MIL 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 MIL identifier specified by the user, without compensating it. For a MIL 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 MIL_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 a MIL_ID. The MIL_ID could be, for example, a newly-allocated buffer or the result of an inquire. (summarize) Specifies that this parameter will accept any valid MIL_ID, but will not internally modify it. (more details...)

Combination values for the values listed in For registering a MIL identifier type parameter in a MIL user-defined function.

You can add one or more of the following values to the above-mentioned values to specify the image buffer type, if MilObjectType 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 MilObjectType parameter is set to a combination of values.

For specifying the type of image buffer when the MilObjectType is set to M_IMAGE
Combination 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.

Type-specific versions of the function

void MfuncParamArrayMilDouble (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_DOUBLE *ParamValuePtr, MIL_INT NumOfItems, MIL_INT Attribute)

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.