MfuncControl

• See also
User Guide:
Script-based user-defined MIL function
Reference:
MfuncAllocScript
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.
MfuncCall
MfuncErrorReport

Description

Parameters

ContextFuncId

Specifies the identifier of the user-defined MIL function context. Depending on the control type, the context must have been allocated using a specific MIL allocation function.

ControlType

Specifies the user-defined MIL function context setting to control.

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

ControlValue

Specifies the setting's new value.

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

Parameter associations

The table below lists possible values for the ControlType and ControlValue parameters.

• For script-based user-defined MIL functions

The following ControlType and ControlValue parameter settings can be specified when the function context being controlled is a script-based user-defined MIL function context allocated using MfuncAllocScript().

For script-based user-defined MIL functions
ControlType		Description
	ControlValue
M_ADD_SCRIPT_REFERENCE		Adds the specified DLL to the list of DLLs that are referred to during runtime. This control type is not relevant for Python. INQ (summarize) Adds the specified DLL to the list of DLLs that are referred to during runtime. INQ (more details...)
	M_PTR_TO_DOUBLE( MIL_CONST_TEXT_PTR String )	Casts the address of the string identifying the path and file name of the DLL, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. (summarize) Casts the address of the string identifying the path and file name of the DLL, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. (more details...)
			Parameters
			String This parameter specifies the string whose address to cast.
				MIL_TEXT("String") 1 Specifies the path and file name of the DLL your script/function requires to run.
M_COMPILE		Sets when the script is reloaded from disk and recompiled. INQ (summarize) Sets when the script is reloaded from disk and recompiled. INQ (more details...)
	M_MODIFIED	Specifies that the script is recompiled only if the file on disk has changed. This is the default value. (summarize) Specifies that the script is recompiled only if the file on disk has changed. (more details...)
	M_ONCE	Specifies that the script is only compiled once.
M_DEBUG_INFORMATION		Sets if the interpreter interface DLL must generate debug information for the script. This control type is not relevant for Python. INQ (summarize) Sets if the interpreter interface DLL must generate debug information for the script. INQ (more details...)
	M_NO	Specifies that the script is compiled in release mode, using optimization flags. This is the default value. (summarize) Specifies that the script is compiled in release mode, using optimization flags. (more details...)
	M_YES	Specifies that the script is compiled in debug mode, and that the necessary debug information is generated. When choosing this control value, you must specifiy the directory in which to save the debug information using the M_DEBUG_INFORMATION_PATH control type. (summarize) Specifies that the script is compiled in debug mode, and that the necessary debug information is generated. (more details...)
M_DEBUG_INFORMATION_PATH		Sets the path of the directory in which the compiled version of the script and other files are created, if they are relevant for the scripting language. This control type is not relevant for Python. INQ (summarize) Sets the path of the directory in which the compiled version of the script and other files are created, if they are relevant for the scripting language. INQ (more details...)
	M_PTR_TO_DOUBLE( MIL_CONST_TEXT_PTR String )	Casts the address of the string identifying the path, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. (summarize) Casts the address of the string identifying the path, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. (more details...)
			Parameters
			String This parameter specifies the string whose address to cast.
				MIL_TEXT("String") 1 Specifies the path of the directory in which the debug information will be stored. This is also the directory in which the compiled version of the script is created. The compiled version of the script (assembly file) will only be created in the specified directory if you choose to generate debug information using M_DEBUG_INFORMATION.

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Type-specific versions of the function when using a C compiler

void MfuncControlInt64 (MIL_ID ContextFuncId, MIL_INT64 ControlType, MIL_INT64 ControlValue) Details Parameters ContextFuncId See ContextFuncId of the main function for a description. ControlType See ControlType of the main function for a description. ControlValue See ControlValue of the main function for a description.

void MfuncControlDouble (MIL_ID ContextFuncId, MIL_INT64 ControlType, MIL_DOUBLE ControlValue) Details Parameters ContextFuncId See ContextFuncId of the main function for a description. ControlType See ControlType of the main function for a description. ControlValue See ControlValue of the main function for a description.