DeleteString (System subroutine): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (copied content from PDF and updated to be system only) |
||
| Line 1: | Line 1: | ||
{{Template:System:DeleteString subtitle}} | {{Template:System:DeleteString subtitle}} | ||
The <var>DeleteString</var> shared subroutine deletes a <var>[[System_class|System]]</var> string. | |||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>(System)</th> | <tr><th>%(System)</th> | ||
<td>The class name in parentheses denotes a shared method. DeleteString can also be invoked via a System object variable, which may be null.</td></tr> | <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> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td> | <td>A string that identifies the string 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 string that is not set. | |||
</ul> | |||
==Examples== | ==Examples== | ||
<ol><li>The following statement deletes the System string called MELANCHOLIC: | |||
<p class="code">%(system):deleteString('MELANCHOLIC')</p></ol> | |||
==See also== | ==See also== | ||
{{Template:System:DeleteString footer}} | {{Template:System:DeleteString footer}} | ||
Revision as of 22:32, 19 March 2011
Delete a system-wide string (System class)
The DeleteString shared subroutine deletes a System 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')