Programmer Guide/Command Reference/NEW: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
NEW <var>itemtype</var> <var>itemname</var> [ [[Programmer_Guide/Command_Reference/Silent|/I]] /U|/uĀ /G ] [ <var>createargs</var> [ <var>createopts</var> ] ] | |||
The <code>NEW</code> command creates a new [[Programmer_Guide/Shell_Items|shell item]] of the type <var>itemtype</var> and named <var>itemname</var>. | |||
;<var>itemtype</var> | |||
:The type of the new [[Programmer_Guide/Shell_Items|shell item]]. This must be unique (in the item namespace of a shell). | |||
;<var>itemname</var> | |||
:The name of the new [[Programmer_Guide/Shell_Items|shell item]]. If set to the character '''*''', the name is choosen automatically. | |||
;<code>/I</code>: Enable [[Programmer_Guide/Command_Reference/Silent|silent error reporting]]. If specified, <code>NEW</code> will generate a warning rather than an error if arguments are missing or it is unable create the new item. | |||
;<var>/G</var>: Garbage collection. If specified, a temporary (or local) item created, which is automatically deleted when exiting the macro. | |||
;<var>/U</var>: If specified, the global item protection is enabled. This means all items created before this item (called the protection-master) are proteced from being deleted, until the global item protection is disabled, which is done by deleting the protection-master). Protected items can only be deleted using a special option of the [[Programmer_Guide/Command_Reference/DELETE|delete command]]. Note: This option is case-sensitive! | |||
;<var>/u</var>: If specified, the created item protected from being deleted. , until the global item protection is disabled, which is done by deleting the protection-master). Note: This option is case-sensitive! | |||
The <code>DELETE</code> command deletes the specified shell items <var>itemname1</var>, <var>itemname2</var>, 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. | |||
Revision as of 11:57, 22 March 2011
NEW itemtype itemname [ /I /U|/u /G ] [ createargs [ createopts ] ]
The NEW command creates a new shell item of the type itemtype and named itemname.
- itemtype
- The type of the new shell item. This must be unique (in the item namespace of a shell).
- itemname
- The name of the new shell item. If set to the character *, the name is choosen automatically.
/I- Enable silent error reporting. If specified,
NEWwill generate a warning rather than an error if arguments are missing or it is unable create the new item.
- /G
- Garbage collection. If specified, a temporary (or local) item created, which is automatically deleted when exiting the macro.
- /U
- If specified, the global item protection is enabled. This means all items created before this item (called the protection-master) are proteced from being deleted, until the global item protection is disabled, which is done by deleting the protection-master). Protected items can only be deleted using a special option of the delete command. Note: This option is case-sensitive!
- /u
- If specified, the created item protected from being deleted. , until the global item protection is disabled, which is done by deleting the protection-master). Note: This option is case-sensitive!
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.
