:DELETE_VAR

Script Statement: Deletes one or all values of a static Variable object.

Syntax

:DELETE_VAR Variable [, Validity Keyword]

Syntax	Description/Format
Variable	Name of the Variable object in which contents should be deleted. Format: AE name, script literal or script variable.
Validity Keyword	Key that should be deleted including its value. Format: AE name, script literal or script variable

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 variable 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 sequence (values of a Variable object).

Script Elements - Read or Modify Objects

About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by function

Open topic with navigation