ScriptParameter element

Defines a parameter script variable. Parameter script variables are typically used to get input from the outside world, e.g., from an operator.

Parent

Parameters

Attributes

Name	Type	Required	Description
id	unsignedInt	Yes	Specifies the unique ID of the parameter script variable.
type	string	Yes	Specifies the parameter type.
values	string	Yes	Specifies the name of the memory file that holds the values to choose from.

Children

Name	Occurrences	Description
Description		Specifies the name of the parameter script variable.

Remarks

At runtime, retrieve the value of a script parameter with IEngine.GetScriptParam by name or ID. The returned ScriptParam is supplied by DataMiner; do not construct it in application code. Its Value is a string. For the behavior when C# code accesses an undefined or empty value, see RunTimeFlags.AllowUndef.