Automation Engine Script Guide > Ordered by Function > Read or Modify Objects > :DELETE_VAR

:DELETE_VAR

Script Statement: Deletes one or all values of a static Variable objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.

Syntax

:DELETE_VAR Variable, [Key]

Syntax

Description/Format

Variable

Name of the Variable object in which contents should be deleted.
Format: AE name, script literal or script variable.

Key

Key that should be deleted including its value.
Format: AE name, scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script.

Comments

Note that this script element can only be used for static Variable objects. For more detailed information refer to the description of the Variable tab.

This script statement deletes all lines of a Variable object if only the parameter variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. has been specified.

If the parameter Key has also been specified, only the relevant line in the Variable object is removed. If "*" has been specified in the Key, the whole content of the Variable object is deleted.

Wildcard characters must not be used. Therefore, you cannot use "*" or "?" to filter several lines in the parameter Key.

Examples

The first example uses this script statement to delete the whole content.

:DELETE_VAR "DATABASE_MAINTENANCE"

The second example only deletes the line which contains the key "Client".

:DELETE_VAR "DATABASE_MAINTENANCE", "Client"

 

See also:

Script element Description

:PUT_VAR

This stores a value in a static Variable object.
GET_VAR

This returns the value of a Variable object.

RESOLVE_VAR

Resolves any kind of variable (prompt values, system variables, script variables, variable objects) in text.
:SET_SCRIPT_VAR Sets the values of script variables by indirect access.
GET_SCRIPT_VAR Returns the values of script variables by indirect access.

PREP_PROCESS_VAR and PREP_PROCESS_VAR_XML

Prepares the processing of a data sequenceAn internal listing of Console outputs or lines of Variable objects, etc. The lines of a data sequence can be accessed by using a PROCESS loop or the script element GET_PROCESS_LINE. The script elements PREP_PROCESS* generate data sequences. (values of a Variable object).

Script Elements - Read or Modify Objects

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH