ListOfObjects (Subsystem function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
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"]] | 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== |
Revision as of 21:47, 16 November 2012
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
- 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.