DeleteGlobal (Subsystem subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Subsystem:DeleteGlobal subtitle}} | {{Template:Subsystem:DeleteGlobal subtitle}} | ||
The <var>DeleteGlobal</var> shared subroutine deletes a subsystem global. | The <var>DeleteGlobal</var> shared subroutine deletes a [[System and Subsystem classes#System and subsystem globals and strings|subsystem global]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:Subsystem:DeleteGlobal syntax}} | {{Template:Subsystem:DeleteGlobal syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><var>%(Subsystem)</var></th> | <tr><th><var>%(Subsystem)</var></th> | ||
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>DeleteGlobal</var> can also be invoked via a <var> | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>DeleteGlobal</var> can also be invoked via a <var>Subsystem</var> object variable, which may be <var>null</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A string that identifies the global to be deleted.</td></tr> | <td>A string that identifies the global to be deleted.</td></tr> | ||
| Line 13: | Line 15: | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors result in request cancellation. | <ul> | ||
<li>All errors result in request cancellation. | |||
<li>It is not an error to delete a global that is not set. | <li>It is not an error to delete a global that is not set. | ||
<li>The <var>Subsystem</var> class <var>DeleteGlobal</var> deletes the global referenced by name for the current subsystem context. You can identify the current context by calling the <var>[[Context_(Subsystem_property)|Context]]</var> property. | <li>The <var>Subsystem</var> class <var>DeleteGlobal</var> deletes the global referenced by name for the current subsystem context. You can identify the current context by calling the <var>[[Context_(Subsystem_property)|Context]]</var> property. | ||
</ul> | </ul> | ||
Revision as of 20:51, 16 November 2012
Delete a subsystem global (Subsystem class)
The DeleteGlobal shared subroutine deletes a subsystem global.
Syntax
%(Subsystem):DeleteGlobal( string)
Syntax terms
| %(Subsystem) | The class name in parentheses denotes a shared method. DeleteGlobal can also be invoked via a Subsystem object variable, which may be null. |
|---|---|
| string | A string that identifies the global to be deleted. |
Usage notes
- All errors result in request cancellation.
- It is not an error to delete a global that is not set.
- The Subsystem class DeleteGlobal deletes the global referenced by name for the current subsystem context. You can identify the current context by calling the Context property.