ListOfObjects (Subsystem function)

From m204wiki
Revision as of 21:47, 16 November 2012 by JAL (talk | contribs)
Jump to navigation Jump to search

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

%slThe 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:

* Matches any group of 0 or more characters
? Matches any single character
" An escape, which means the next character is treated literally, even if it is a double quotation mark ("), question mark (?), or 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.

See also