-
Notifications
You must be signed in to change notification settings - Fork 14
Global Variables API
The GlobalVariable API provides several different types of information for global variables. Global variable name, total number of global variables, etc.
GlobalVariableCheck
GlobalVariableDel
GlobalVariableGet
GlobalVariableName
GlobalVariableSet
GlobalVariableSetOnCondition
GlobalVariablesDeleteAll
GlobalVariablesTotal
Checks the existence of a global variable with the specified name
protected bool GlobalVariableCheck(string name)- name - Global variable name
- Returns true, if the global variable exists, otherwise returns false
Deletes a global variable from the client terminal.
protected bool GlobalVariableDel(string name)- name - Global variable name
- If successful, the function returns true, otherwise it returns false
Returns the value of an existing global variable of the client terminal
protected double GlobalVariableGet(string name)- name - Global variable name
- The value of the existing global variable or 0 in case of an error
Returns the name of a global variable by its ordinal number
protected string GlobalVariableName(int index)- index - Sequence number in the list of global variables
- Global variable name by its ordinal number in the list of global variables
Sets a new value for a global variable. If the variable does not exist, the system creates a new global variable
protected datetime GlobalVariableSet(string name, double value)- name - Global variable name
- value - The new numerical value
- If successful, the function returns the last modification time, otherwise 0
Sets the new value of the existing global variable if the current value equals to the third parameter checkValue
protected bool GlobalVariableSetOnCondition(string name, double value, double checkValue)- name - The name of a global variable
- value - New value
- checkValue - The value to check the current value of the global variable
- If successful, the function returns true, otherwise it returns false
Deletes global variables of the client terminal with specified prefix
protected int GlobalVariablesDeleteAll(string prefixName = "")- prefixName - Prefix (empty string is default value)
- The number of deleted variables
Returns the total number of global variables of the client terminal
protected int GlobalVariablesTotal()- Number of global variables