String (System function): Difference between revisions
Jump to navigation
Jump to search
m (copied content from PDF and updated to be system only) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:System:String subtitle}} | {{Template:System:String subtitle}} | ||
The <var>String</var> read-only property returns the current value of a | The <var>String</var> read-only property returns the current value of a [[System class#System and subsystem globals and strings|system-wide string]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:System:String syntax}} | {{Template:System:String syntax}} | ||
Revision as of 19:31, 27 March 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'))