DeleteGlobal (System subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
(Automatically generated page update)
 
(22 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:System:DeleteGlobal subtitle}}
{{Template:System:DeleteGlobal subtitle}}
The <var>DeleteGlobal</var> shared subroutine deletes a [[System class#System and subsystem globals and strings|system-wide global]].


==Syntax==
==Syntax==
Line 5: Line 6:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>(System)</th>
<tr><th><var class="nobr">%(System)</var></th>
<td>The class name in parentheses denotes a shared method. DeleteGlobal can also be invoked via a System object variable, which may be null.</td></tr>
<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>[[System_class|System]]</var> object variable, which may be <var>null</var>.</td></tr>
<tr><th>string</th>
<tr><th>string</th>
<td><var>String</var> object</td></tr>
<td>A string that identifies the global to be deleted.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul><li>All errors result in request cancellation.
<li>It is not an error to delete a global that is not set.
</ul>
==Examples==
==Examples==
The following statement deletes the system global called <code>SANGUINIC</code>:
<p class="code">%(system):deleteGlobal('SANGUINIC')
</p>
==See also==
==See also==
{{Template:System:DeleteGlobal footer}}
{{Template:System:DeleteGlobal footer}}

Latest revision as of 00:26, 16 February 2014

Delete a system-wide global (System class)

The DeleteGlobal shared subroutine deletes a system-wide global.

Syntax

%(System):DeleteGlobal( string)

Syntax terms

%(System) The class name in parentheses denotes a shared method. DeleteGlobal can also be invoked via a System 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.

Examples

The following statement deletes the system global called SANGUINIC:

%(system):deleteGlobal('SANGUINIC')

See also