ListOfObjects (Subsystem function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| Line 33: | Line 33: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <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>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. | ||
</ul> | </ul> | ||
Revision as of 03:32, 12 June 2013
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
| %sl | The 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 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:
| ||||||
| 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
- The format of the output Stringlist is:
Columns Contents 1-10 The userid of the user that saved the subsystem object. 12-28 The date and time the object was saved in YY/MM/DD HH:MI:SS format. 30-52 The 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.