| MIL 10 Reference
| Customize Help
| Save Settings

MfuncParamValue


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MfuncParamCheck
Next
Synopsis
Read the value of the specified MIL function parameter.
Syntax
void MfuncParamValue(
MIL_ID ContextFuncId, //in
MIL_INT ParamIndex, //in
void *ParamValuePtr //out
)
Description

This function allows you to read the value of a parameter registered in the master function of your user-defined MIL function, from the slave function. The requested value is written to the address specified by the ParamValuePtr parameter.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
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 variable in which to write the value of the specified parameter. The type of the variable depends on the type of the parameter registered in the master function.

Return value
Returns the value of the specified parameter.
Type-specific versions of the function
void MfuncParamValueArrayMilDouble (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_DOUBLE **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueArrayMilId (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_ID **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueArrayMilInt (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_INT **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueArrayMilInt32 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_INT32 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueArrayMilInt64 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_INT64 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueArrayMilUint (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_UINT **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueArrayMilUint32 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_UINT32 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueArrayMilUint64 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_UINT64 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilDouble (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_DOUBLE **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilId (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_ID **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilInt (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_INT **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilInt32 (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_INT32 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilInt64 (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_INT64 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilUint (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_UINT **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilUint32 (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_UINT32 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstArrayMilUint64 (MIL_ID ContextFuncId, MIL_INT ParamIndex, const MIL_UINT64 **ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueConstMilText (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_CONST_TEXT_PTR *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueFilename (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_CONST_TEXT_PTR *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilDouble (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_DOUBLE *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilId (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_ID *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilInt (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_INT *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilInt32 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_INT32 *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilInt64 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_INT64 *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilText (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_TEXT_PTR *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilUint (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_UINT *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilUint32 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_UINT32 *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
void MfuncParamValueMilUint64 (MIL_ID ContextFuncId, MIL_INT ParamIndex, MIL_UINT64 *ParamValuePtr)
Details
Parameters

ContextFuncId

See ContextFuncId of the main function for a description.

ParamIndex

See ParamIndex of the main function for a description.

ParamValuePtr

See ParamValuePtr of the main function for a description.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.