GetObject (Subsystem function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
(Automatically generated page update)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:Subsystem:GetObject subtitle}}
{{Template:Subsystem:GetObject subtitle}}
The <var>GetObject</var>shared method retrieves a copy of a specified <var>[[Subsystem_class#System-wide_objects|subsystem-wide]]</var> object.
The <var>GetObject</var> shared method retrieves a copy of a specified [[Subsystem_class#System-wide_objects|"subsystem-wide object"]].


==Syntax==
==Syntax==
Line 7: Line 7:
<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. gen 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. gen is set to 0 if the method encounters a problem and cannot retrieve the object.</td></tr>
<tr><th>%(Subsystem)</th>
<tr><th><var class="nobr">%(Subsystem)</var></th>
<td>The class name in parentheses denotes a shared method. <var>GetObject</var> can also be invoked via a <var>[[Subsystem_class|Subsystem]]</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>Subsystem</var> 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 subsystem-wide object is identified.</td></tr>
<td>The string name by which the subsystem-wide object is identified.</td></tr>
Line 14: Line 14:
<td>The object variable to which the subsystem-wide object is assigned.</td></tr>
<td>The object variable to which the subsystem-wide object is assigned.</td></tr>
</table>
</table>


==See also==
==See also==
{{Template:Subsystem:GetObject footer}}
{{Template:Subsystem:GetObject footer}}

Latest revision as of 00:31, 16 February 2014

Get a subsystem object (Subsystem class)

The GetObject shared method retrieves a copy of a specified "subsystem-wide object".

Syntax

[%number =] %(Subsystem):GetObject( string, object)

Syntax terms

%numberThe 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. gen is set to 0 if the method encounters a problem and cannot retrieve the object.
%(Subsystem) The class name in parentheses denotes a shared method. GetObject can also be invoked via a Subsystem object variable, which may be Null.
string The string name by which the subsystem-wide object is identified.
object The object variable to which the subsystem-wide object is assigned.

See also