ListOfObjects (Subsystem function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (copied content from PDF and updated to be subsystem only)
m (syntax terms)
Line 6: Line 6:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<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>%sl</th><td>The <var>Stringlist</var> variable that contains the data about the objects selected according to the <var class="term">nameW</var> and <var class="term">subsysW</var> patterns.</td></tr>
<tr><th>%(Subsystem)</th>
<tr><th>%(Subsystem)</th>
<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>
<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>

Revision as of 10:22, 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

%slThe Stringlist variable that contains the data about the objects selected according to the nameW and subsysW patterns.
%(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 (*), that is, all system-wide objects, and its eligible wildcard characters are shown below:

  • * Matches any group of 0 or more characters
  • ? Matches any single character
  • " An escape, which means the next character is treated literally, even if it is a double quotation mark ("), question mark (?), or 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.

Examples

See also