ListOfObjects (Subsystem function): 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:ListOfObjects subtitle}} | {{Template:Subsystem:ListOfObjects subtitle}} | ||
The <var>ListOfObjects</var> method returns a <var>[[Stringlist class|Stringlist]]</var> containing information about <var>[[Subsystem_class#System-wide_objects|subsystem-wide]]</var> objects. <var>ListOfObjects</var> is a shared method. | |||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%sl</th><td>The <var>Stringlist</var> variable that contains the data about the objects selected according to the <var class="term">nameW</var> pattern(s).</td></tr> | ||
<tr><th>(Subsystem)</th> | <tr><th>%(Subsystem)</th> | ||
<td>The class name in parentheses denotes a shared method. ListOfObjects can also be invoked via a | <td>The class name in parentheses denotes a shared method. <var>ListOfObjects</var> can also be invoked via a <var>[[Subsystem_class|subsystem]]</var> object variable, which may be <var>null</var>.</td></tr> | ||
<tr><th> | <tr><th>nameW</th> | ||
<td><var> | <td>An optional identifying string which may include wildcard characters. Descriptions of the <var>system-wide</var> objects whose names match the <var class="term">nameW</var> pattern(s) are returned to the <var class="term">%sl</var> <var>Stringlist</var>. | ||
<tr><th> | <p>This argument defaults to an asterisk (<code>*</code>), that is, all <var>system-wide</var> objects, and its eligible wildcard characters are shown below:</p> | ||
<td><var> | <ul><li><code>*</code> Matches any group of 0 or more characters | ||
<li><code>?</code> Matches any single character | |||
<li><code>"</code> An escape, which means the next character is treated literally, even if it is a double quotation mark (<code>"</code>), question mark (<code>?</code>), or asterisk (<code>*</code>)</ul></td></tr> | |||
<tr><th>subsysW</th> | |||
<td>An optional string, which may include wildcard characters, that identifies the associated <var>subsystem</var> of the objects whose descriptions are returned. This argument defaults to an asterisk (<code>*</code>), that is, all <var>subsystems</var>, and its eligible wildcard characters are the same as those for <var class="term">nameW</var>, above.</td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors result in request cancellation. | |||
<li>The <var>Subsystem</var> class <var>ListOfGlobals</var> method applies to the subsys argument only; it ignores the current subsystem context. | |||
<li>The items placed on the target <var>Stringlist</var> are put there in no particular order. | |||
<li><var>ListOfObjects</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 6.7 and later. | |||
</ul> | |||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:Subsystem:ListOfObjects footer}} | {{Template:Subsystem:ListOfObjects footer}} | ||
Revision as of 10:14, 24 March 2011
List of subsystem objects (Subsystem class)
The ListOfObjects method returns a Stringlist containing information about subsystem-wide objects. ListOfObjects is a shared method.
Syntax
%sl = %(Subsystem):ListOfObjects[( [subsysW], [nameW])]
Syntax terms
| %sl | The Stringlist variable that contains the data about the objects selected according to the nameW pattern(s). |
|---|---|
| %(Subsystem) | The class name in parentheses denotes a shared method. ListOfObjects can also be invoked via a subsystem object variable, which may be null. |
| nameW | An optional identifying string which may include wildcard characters. Descriptions of the system-wide objects whose names match the nameW pattern(s) are returned to the %sl Stringlist.
This argument defaults to an asterisk (
|
| subsysW | An optional string, which may include wildcard characters, that identifies the associated subsystem of the objects whose descriptions are returned. This argument defaults to an asterisk (*), that is, all subsystems, and its eligible wildcard characters are the same as those for nameW, above. |
Usage notes
- All errors result in request cancellation.
- The Subsystem class ListOfGlobals method applies to the subsys argument only; it ignores the current subsystem context.
- The items placed on the target Stringlist are put there in no particular order.
- ListOfObjects is available in "Sirius Mods" Version 6.7 and later.