DeleteString (Subsystem subroutine): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (copied content from PDF and updated to be subsystem only) |
||
| Line 1: | Line 1: | ||
{{Template:Subsystem:DeleteString subtitle}} | {{Template:Subsystem:DeleteString subtitle}} | ||
The <var>DeleteString</var> shared subroutine deletes a <var>[[Subsystem_class|SubSystem]]</var> string. | |||
==Syntax== | ==Syntax== | ||
| Line 6: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>(Subsystem)</th> | <tr><th>(Subsystem)</th> | ||
<td>The class name in parentheses denotes a shared method. DeleteString can also be invoked via a | <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> | ||
<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. | |||
<li><var>DeleteString</var> deletes the string 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> | |||
==Examples== | ==Examples== | ||
<ol><li>See the <var>[[DeleteString_(System_subroutine)#Examples|"DeleteString (System subroutine) Example"]]</var>.</ol> | |||
==See also== | ==See also== | ||
{{Template:Subsystem:DeleteString footer}} | {{Template:Subsystem:DeleteString footer}} | ||
Revision as of 22:33, 19 March 2011
Delete a subsystem string (Subsystem class)
The DeleteString shared subroutine deletes a SubSystem string.
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 | 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.
- DeleteString deletes the string referenced by name for the current subsystem context. You can identify the current context by calling the Context property