ListOfObjects (System function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (system wide)
m (system wide)
Line 7: Line 7:
<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> pattern.</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> pattern.</td></tr>
<tr><th>%(System)</th>
<tr><th><var>%(System)</var></th>
<td>The class name in parentheses denotes a shared method. <var>ListOfObjects</var> can also be invoked via a <var>[[System_class|system]]</var> object variable, which may be <var>null</var>.</td></tr>
<td>The class name in parentheses denotes a shared method. <var>ListOfObjects</var> can also be invoked via a <var>[[System_class|system]]</var> object variable, which may be <var>null</var>.</td></tr>
<tr><th>nameW</th>
<tr><th>nameW</th>

Revision as of 01:16, 3 May 2011

List of system objects (System class)

The ListOfObjects method returns a Stringlist containing information about "system-wide objects". ListOfObjects is a shared method.

Syntax

%sl = %(System):ListOfObjects[( [string])]

Syntax terms

%slThe Stringlist variable that contains the data about the objects selected according to the nameW pattern.
%(System) The class name in parentheses denotes a shared method. ListOfObjects can also be invoked via a system object variable, which may be null.
nameW An optional identifying string which may include wildcard characters. Descriptions of the system-wide 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 (*)

Usage notes

  • All errors result in request cancellation.
  • The items placed on the target Stringlist are put there in no particular order.
  • ListOfObjects is available in "Sirius Mods" Version 6.7 and later.

Examples

See also