getDollarValue()

This function returns the value of a dollar parameter.

Synopsis

string getDollarValue(string parameter);

Parameters

Parameter Description
parameter Name of the dollar parameter, for example, "$valve"

Return value

The function returns an empty string in the event of errors or else the value of the parameter.

Error

Errors can be queried with getLastError(), for example, missing or incorrect parameters.

Description

This function returns the value of a specific dollar parameter. It only returns the value but does not recognize the parameter as a parameter.

The function getDollarValue() only makes sense when using childpanels. Used and not defined $ parameters in panel references cannot be resolved!

Example

The function checks whether the parameter $A = "My Test" exists.

main()
{
  if ( isDollarDefined("$A") )
  {
    this.text = getDollarValue("$A"); // Returns "My Test" as a
    value.
  }
  else
  this.text = "$A is not defined!"
}

Assignment

Graphics

Availability

UI