ListOfObjects (Subsystem function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 15: | Line 15: | ||
<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> | <p> | ||
This argument defaults to an asterisk (< | This argument defaults to an asterisk (<tt>*</tt>), that is, all system-wide objects, and its eligible wildcard characters are shown below:</p> | ||
< | <table class="noVar"> | ||
< | <tr><th>*</th> | ||
< | <td>Matches any group of 0 or more characters</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> | |||
<tr><th>subsysW</th> | <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 (< | <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> | ||
</table> | </table> | ||
| Line 28: | Line 34: | ||
<ul> | <ul> | ||
<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 21:19, 16 November 2012
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 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
- 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.