ListOfObjects (Subsystem function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
mNo edit summary |
||
Line 24: | Line 24: | ||
<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> | ||
==See also== | ==See also== | ||
{{Template:Subsystem:ListOfObjects footer}} | {{Template:Subsystem:ListOfObjects footer}} |
Revision as of 20:28, 21 April 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
%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.