DeleteString (System subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
(Automatically generated page update)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:System:DeleteString subtitle}}
{{Template:System:DeleteString subtitle}}
The <var>DeleteString</var> shared subroutine deletes a [[System class#System and subsystem globals and strings|system-wide string]].
==Syntax==
==Syntax==
{{Template:System:DeleteString syntax}}
{{Template:System:DeleteString syntax}}
===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. <var>DeleteString</var> can also be invoked via a <var>[[System_class|System]]</var> object variable, which may be <var>null</var>.</td></tr>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>DeleteString</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>A string that identifies the string to be deleted.</td></tr>
<td>A string that identifies the string to be deleted.</td></tr>
Line 16: Line 18:


==Examples==
==Examples==
<ol><li>The following statement deletes the System string called MELANCHOLIC:
The following statement deletes the system string called <code>MELANCHOLIC</code>:
<p class="code">%(system):deleteString('MELANCHOLIC')</p></ol>
<p class="code">%(system):deleteString('MELANCHOLIC')</p>


==See also==
==See also==
{{Template:System:DeleteString footer}}
{{Template:System:DeleteString footer}}

Latest revision as of 00:26, 16 February 2014

Delete a system-wide string (System class)

The DeleteString shared subroutine deletes a system-wide string.

Syntax

%(System):DeleteString( string)

Syntax terms

%(System) The class name in parentheses denotes a shared method. DeleteString can also be invoked via a System object variable, which may be null.
string A string that identifies the string to be deleted.

Usage notes

  • All errors result in request cancellation.
  • It is not an error to delete a string that is not set.

Examples

The following statement deletes the system string called MELANCHOLIC:

%(system):deleteString('MELANCHOLIC')

See also