Programmer Guide/Command Reference/DELETE: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
(→Usage) |
||
| Line 2: | Line 2: | ||
Delete [[Programmer_Guide/Shell_Items|shell items]]. | Delete [[Programmer_Guide/Shell_Items|shell items]]. | ||
==Usage== | ==Usage== | ||
DELETE [ [[Programmer_Guide/Command_Reference_Options/Variables|/Variables]] ] [/unprotect] [ /Silent | [[Programmer_Guide/Command_Reference_Options/Silent|/?]] ] [ [[Programmer_Guide/Command_Reference_Options/-|/-]] ] <var>item<sub>1</sub></var> [ <var>item<sub>2</sub></var> … ] | |||
;<var>item<sub>1</sub></var>, <var>item<sub>2</sub></var>: name of the shell item to delete or name of a variable containing the name of shell item to delete (if <code>/Variable</code> is specified) | |||
;<code>/Silent</code>: If specified, <code>DELETE</code> will generate a warning rather than an error if arguments are missing or if it is unable delete the arguments. | |||
;<code>/unprotect</code> (case-sensitive!): If specified, <code>DELETE</code> will remove any protection from the respective item before deleting. This is the only way of deleting a [[Programmer_Guide/Shell_Items#Protected_shell_items|protected shell item]]. Note that, unlike most other options, the <code>/unprotect</code> option is case-sensitive meaning that you have to use the ''lower-case'' letter '''u''' to indicate that you are really serious. | |||
:;<code>/Variables</code>: Indicates that the arguments are variable names containing the shell item name. The respective shell items are deleted, and the variables are then reset to empty. | :;<code>/Variables</code>: Indicates that the arguments are variable names containing the shell item name. The respective shell items are deleted, and the variables are then reset to empty. | ||
The <code>DELETE</code> command deletes the specified shell items. Some types of shell items (e.g. [[Programmer_Guide/Shell_Items/SPU|SPU items)]] cannot be deleted while they are active, causing an error to be emitted. If a display item is deleted, all items contained in the display are removed too (i.e. graphs and dialogs items). If a dialog item contained in a 'dialog only' display item is deleted, the display item is also removed. If a DDE conversation item (DDEConv) is removed, the conversation is ended before the item is deleted. | |||
The | The completion code of the command (0 for success) is assiged to the variable <var>RC</var> and is also returned as result of the command. | ||
==See also== | ==See also== | ||
[[Programmer_Guide/Shell_Items|shell items]], [[../NEW|NEW]], [[../SET|SET]] | [[Programmer_Guide/Shell_Items|shell items]], [[../NEW|NEW]], [[../SET|SET]] | ||
Revision as of 15:34, 24 April 2014
Delete shell items.
Usage
DELETE [ /Variables ] [/unprotect] [ /Silent | /? ] [ /- ] item1 [ item2 … ]
- item1, item2
- name of the shell item to delete or name of a variable containing the name of shell item to delete (if
/Variableis specified) /Silent- If specified,
DELETEwill generate a warning rather than an error if arguments are missing or if it is unable delete the arguments. /unprotect(case-sensitive!)- If specified,
DELETEwill remove any protection from the respective item before deleting. This is the only way of deleting a protected shell item. Note that, unlike most other options, the/unprotectoption is case-sensitive meaning that you have to use the lower-case letter u to indicate that you are really serious./Variables- Indicates that the arguments are variable names containing the shell item name. The respective shell items are deleted, and the variables are then reset to empty.
The DELETE command deletes the specified shell items. Some types of shell items (e.g. SPU items) cannot be deleted while they are active, causing an error to be emitted. If a display item is deleted, all items contained in the display are removed too (i.e. graphs and dialogs items). If a dialog item contained in a 'dialog only' display item is deleted, the display item is also removed. If a DDE conversation item (DDEConv) is removed, the conversation is ended before the item is deleted.
The completion code of the command (0 for success) is assiged to the variable RC and is also returned as result of the command.
See also
Examples
// create a table item called "hugoItem", and store // this name in a variable called "#hugo" #hugo := new table hugoItem // table item "hugoItem" will be deleted *and* "#hugo" will be cleared delete /Var #hugo
