DeleteGlobal (System subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (stolen from the pdf)
m (copied content from PDF and updated to be system only)
Line 1: Line 1:
{{Template:System:DeleteGlobal subtitle}}
{{Template:System:DeleteGlobal subtitle}}
The <var>DeleteGlobal</var> shared subroutine deletes a subsystem global.
The <var>DeleteGlobal</var> shared subroutine deletes a system global.


==Syntax==
==Syntax==
Line 15: Line 15:
<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 Subsystem 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 10:47, 19 March 2011

Delete a system-wide global (System class)

The DeleteGlobal shared subroutine deletes a system 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

  1. The following statement deletes the system global called SANGUINIC:

    %(system):deleteGlobal('SANGUINIC')

See also