Class VariableFunctions.DeleteVariableFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
com.inductiveautomation.ignition.common.expressions.legacy.VariableFunctions.DeleteVariableFunction
- All Implemented Interfaces:
Function
- Enclosing class:
VariableFunctions
deleteVariable(name) deletes a named variable. Returns a boolean indicating whether the
variable name had a value.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute(Expression[] args) Execute this function, and return the function's qualified value.Returns a string to be used in the auto-generated function documentation.protected StringClass<?> getType()Returns the type that this function will return upon executionMethods inherited from class AbstractFunction
executeArg, initArgs, log, validateNumArgsMethods inherited from class BaseFunction
connect, copy, disconnect, executeAll, shutdown, startupMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Function
getDescription
-
Field Details
-
FUNCTION_NAME
- See Also:
-
-
Constructor Details
-
DeleteVariableFunction
public DeleteVariableFunction()
-
-
Method Details
-
getFunctionDisplayName
- Specified by:
getFunctionDisplayNamein classAbstractFunction
-
execute
Description copied from interface:FunctionExecute this function, and return the function's qualified value.- Parameters:
args- the arguments for the function- Returns:
- the result of the function evaluation as a
QualifiedValue - Throws:
ExpressionException- if an error occurs during execution
-
getArgDocString
Description copied from interface:FunctionReturns a string to be used in the auto-generated function documentation. The string should represent the arguments for the function, such as "string, count" for the "repeat" function.- Returns:
- the argument documentation string
-
getType
-