DeleteString (Subsystem subroutine): Difference between revisions
Jump to navigation
Jump to search
m (copied content from PDF and updated to be subsystem only) |
(Automatically generated page update) |
||
| (19 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Subsystem:DeleteString subtitle}} | {{Template:Subsystem:DeleteString subtitle}} | ||
==Syntax== | ==Syntax== | ||
| Line 6: | Line 5: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>(Subsystem)</th> | <tr><th><var class="nobr">%(Subsystem)</var></th> | ||
<td>The class name in parentheses denotes a shared method. <var>DeleteString</var> can also be invoked via a <var>[[Subsystem_class|SubSystem]]</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>[[Subsystem_class|SubSystem]]</var> object variable, which may be <var>null</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td> | <td>The string to be deleted.</td></tr> | ||
</table> | </table> | ||
| Line 19: | Line 18: | ||
==Examples== | ==Examples== | ||
< | The following statement deletes the subsystem string called <code>LUGUBRIOUS</code>: | ||
<p class="code">%(subsystem):deleteString('LUGUBRIOUS')</p> | |||
==See also== | ==See also== | ||
{{Template:Subsystem:DeleteString footer}} | {{Template:Subsystem:DeleteString footer}} | ||
Latest revision as of 00:31, 16 February 2014
Delete a subsystem string (Subsystem class)
Syntax
%(Subsystem):DeleteString( string)
Syntax terms
| %(Subsystem) | The class name in parentheses denotes a shared method. DeleteString can also be invoked via a SubSystem object variable, which may be null. |
|---|---|
| string | 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.
- DeleteString deletes the string referenced by name for the current subsystem context. You can identify the current context by calling the Context property
Examples
The following statement deletes the subsystem string called LUGUBRIOUS:
%(subsystem):deleteString('LUGUBRIOUS')