ListOfObjects (Subsystem function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(12 intermediate revisions by 3 users not shown)
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 [[Subsystem_class#System-wide_objects|"subsystem-wide objects"]]. <var>ListOfObjects</var> is a shared method.
The <var>ListOfObjects</var> shared method returns a <var>[[Stringlist class|Stringlist]]</var> containing information about [[Subsystem_class#System-wide_objects|"subsystem-wide objects"]].  


==Syntax==
==Syntax==
{{Template:Subsystem:ListOfObjects syntax}}
{{Template:Subsystem:ListOfObjects syntax}}
===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> and <var class="term">subsysW</var> patterns.</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><var>%(Subsystem)</var></th>
 
<td>The class name in parentheses denotes a ÝÝNotation conventions for methods#Shared methods|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><var class="nobr">%(Subsystem)</var></th>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>ListOfObjects</var> can also be invoked via a <var>Subsystem</var> object variable, which may be <var>Null</var>.</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 (<tt>*</tt>), 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>
 
<tr><th>nameW</th>
<tr><th>nameW</th>
<td>An optional identifying string which may include wildcard characters. Descriptions of the <var>subsystem</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>.
<td>An optional identifying string which may include wildcard characters. Descriptions of the <var>subsystem</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>.
<p>This argument defaults to an asterisk (<code>*</code>), that is, all system-wide objects, and its eligible wildcard characters are shown below:</p>
<p>
<ul><li><code>*</code> Matches any group of 0 or more characters
This argument defaults to an asterisk (<tt>*</tt>), that is, all system-wide objects, and its eligible wildcard characters are shown below:</p>
<li><code>?</code> Matches any single character
<table class="noVar">
<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>*</th>
<tr><th>subsysW</th>
<td>Matches any group of 0 or more characters</td></tr>
<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>
 
<tr><th>?</th>
<td>Matches any single character</td></tr>
 
<tr><th>"</th>
<td>An escape, which means the next character is treated literally, even if it is a double quotation mark (<tt>"</tt>), question mark (<tt>?</tt>), or asterisk (<tt>*</tt>)</td></tr>
</table></td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
<ul><li>All errors result in request cancellation.
<ul>
<li>The format of the output Stringlist is:
<table>
<tr class="head><th>Columns</th><th>Contents</th></tr>
<tr><td>1-10</td><td>The userid of the user that saved the subsystem object.</td></tr>
<tr><td>12-28</td><td>The date and time the object was saved in YY/MM/DD HH:MI:SS format.</td></tr>
<tr><td>30-52</td><td>The name of the subsubsystem with which the object is associated.</td></tr>
<tr><td>54-</td><td>The name of the subsystem global.</td></tr>
</table>
<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 <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>The items placed on the target <var>Stringlist</var> are put there in no particular order.

Latest revision as of 13:00, 14 May 2016

List of subsystem objects (Subsystem class)

The ListOfObjects shared method returns a Stringlist containing information about "subsystem-wide objects".

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.
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.
nameW An optional identifying string which may include wildcard characters. Descriptions of the subsystem 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 (*)

Usage notes

  • The format of the output Stringlist is:
    ColumnsContents
    1-10The userid of the user that saved the subsystem object.
    12-28The date and time the object was saved in YY/MM/DD HH:MI:SS format.
    30-52The name of the subsubsystem with which the object is associated.
    54-The name of the subsystem global.
  • 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.

See also