GetObject (System function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (add italics) |
||
| Line 1: | Line 1: | ||
{{Template:System:GetObject subtitle}} | {{Template:System:GetObject subtitle}} | ||
The <var>GetObject</var> shared method retrieves a copy of a specified [[System_class#System-wide_objects|"system-wide object"]] | The <var>GetObject</var> shared method retrieves a copy of a specified [[System_class#System-wide_objects|"system-wide object."]] | ||
==Syntax== | ==Syntax== | ||
{{Template:System:GetObject syntax}} | {{Template:System:GetObject syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th><td>The generation number associated with name. This is a positive integer (initially set to 1) that increases by one each time the name object is updated. %number is set to 0 if the method encounters a problem and cannot retrieve the object.</td></tr> | <tr><th>%number</th> | ||
<td>The generation number associated with name. This is a positive integer (initially set to 1) that increases by one each time the name object is updated. <var class="term">%number</var> is set to 0 if the method encounters a problem and cannot retrieve the object.</td></tr> | |||
<tr><th><var class="nobr">%(System)</var></th> | <tr><th><var class="nobr">%(System)</var></th> | ||
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>GetObject</var> can also be invoked via a <var>System</var> class 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>GetObject</var> can also be invoked via a <var>System</var> class object variable, which may be <var>Null</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>The string name by which the system-wide object is identified.</td></tr> | <td>The string name by which the system-wide object is identified.</td></tr> | ||
<tr><th>object</th> | <tr><th>object</th> | ||
<td>The object variable to which the system-wide object is assigned.</td></tr> | <td>The object variable to which the system-wide object is assigned.</td></tr> | ||
Latest revision as of 15:34, 10 April 2018
Get a system-wide object (System class)
The GetObject shared method retrieves a copy of a specified "system-wide object."
Syntax
[%number =] %(System):GetObject( string, object)
Syntax terms
| %number | The generation number associated with name. This is a positive integer (initially set to 1) that increases by one each time the name object is updated. %number is set to 0 if the method encounters a problem and cannot retrieve the object. |
|---|---|
| %(System) | The class name in parentheses denotes a shared method. GetObject can also be invoked via a System class object variable, which may be Null. |
| string | The string name by which the system-wide object is identified. |
| object | The object variable to which the system-wide object is assigned. |