ListOfObjects (Subsystem function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 4: | Line 4: | ||
==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> | <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> | <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>nameW</th> | <tr><th>nameW</th> | ||
<td>An optional identifying string which may include wildcard characters. | <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 (<code>*</code>), that is, all system-wide objects, and its eligible wildcard characters are shown below:</p> | ||
<ul> | |||
<li><code>*</code> Matches any group of 0 or more characters | |||
<li><code>?</code> Matches any single character | <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> | <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> | <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> | <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> | ||
| Line 20: | Line 26: | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors result in request cancellation. | <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 <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. | ||
Revision as of 21:17, 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 (
|
| 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.