GetDefaultValue

(Engine-Level Function)

Description: Returns a variable's default value.
Returns: Varies
Usage: Script or steady state.
Function Groups: Compilation and On-Line Modifications,  Variable
Related to: SetDefault | FindVariable
Format: GetDefaultValue(Variable)
Parameters:  
Variable
Required. Any expression for the variable value.
Comments: If the given variable does not have a default value this function will return Invalid. The current value of Variable does not affect the return value of this function.

Example:

  If ! Valid(defValue);
  [
    defValue = GetDefaultValue(FindVariable("originalVal", Self(), 0, 1));
  ]

The above statement will assign the default value of original to defValue. The reason that the statement is inside a script is because FindVariable may only appear inside a script.