Programmer Guide/Command Reference/DELETE: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
;<var>itemname</var>: The name of the shell item to delete. | ;<var>itemname</var>: The name of the shell item to delete. | ||
;<code>/Silent</code>: If specified, <code>DELETE</code> will generate a warning rather than an error if arguments are missing or it is unable delete the arguments. | ;<code>/Silent</code>: If specified, <code>DELETE</code> will generate a warning rather than an error if arguments are missing or 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/Protected_item|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 | ;<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/Protected_item|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'''. | ||
;<code>/Variables</code>: Indicates that the <var>itemname1</var>...<var>itemnamen</var> arguments are variable names. In this case, each itemname is interpreted as the name of a shell item. The respective shell items are deleted, and the variables are then reset to empty. | ;<code>/Variables</code>: Indicates that the <var>itemname1</var>...<var>itemnamen</var> arguments are variable names. In this case, each itemname is interpreted as the name of a shell item. The respective shell items are deleted, and the variables are then reset to empty. | ||
Revision as of 16:58, 21 March 2011
DELETE [ /Variables ] [/unprotect] [ /Silent ] [ /- ] itemname1 [ itemname2... ]
The DELETE command deletes the specified shell items itemname1, itemname2, and so on. 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.
- itemname
- The name of the shell item to delete.
/Silent- If specified,
DELETEwill generate a warning rather than an error if arguments are missing or 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. /Variables- Indicates that the itemname1...itemnamen arguments are variable names. In this case, each itemname is interpreted as the name of a shell item. The respective shell items are deleted, and the variables are then reset to empty.
// 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
