String (System function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 6: | Line 6: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%value</th><td>This string is set to the current value of the named string, or it is set to null if the named string is not set.</td></tr> | <tr><th>%value</th><td>This string is set to the current value of the named string, or it is set to null if the named string is not set.</td></tr> | ||
<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods | <tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>String</var> can also be invoked via a <var>System</var> object variable, which may be <var>null</var>.</td></tr> | ||
<tr><th>name</th> <td>A string that identifies the global string to be retrieved.</td></tr> | <tr><th>name</th> <td>A string that identifies the global string to be retrieved.</td></tr> | ||
</table> | </table> | ||
Revision as of 18:28, 30 November 2011
Get a system-wide string (System class)
The String read-only property returns the current value of a system-wide string.
Syntax
%value = %(System):String( name)
Syntax terms
| %value | This string is set to the current value of the named string, or it is set to null if the named string is not set. |
|---|---|
| %(System) | The class name in parentheses denotes a shared method. String can also be invoked via a System object variable, which may be null. |
| name | A string that identifies the global string to be retrieved. |
Examples
- The following statement prints the value of the subsystem string called EMERALDS:
print %(system):string('EMERALDS')
- A common use of system strings might be to hold a complex shared data-structure in the form of XML. Such a string can be loaded into an XmlDoc object fairly easily:
%sharedDoc is object xmlDoc auto new ... %sharedDoc:loadXml(%(system):string('SharedDoc'))