ListOfObjects (System function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax terms) |
||
| Line 8: | Line 8: | ||
<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><var>%(System)</var></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| | <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> | <tr><th>string</th> | ||
<td>An optional identifying string which may include wildcard characters. Descriptions of the system-wide objects whose names match the <var class="term"> | <td>An optional identifying string which may include wildcard characters. Descriptions of the system-wide objects whose names match the <var class="term">string</var> pattern(s) are returned to the <var class="term">%sl</var> <var>Stringlist</var>. | ||
<p>This argument defaults to an asterisk (< | <p>This argument defaults to an asterisk (<tt>*</tt>), 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 | <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 (< | <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 (<tt>*</tt>)</ul></td></tr> | ||
</table> | </table> | ||
Revision as of 01:50, 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
| %sl | The 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. |
| string | An optional identifying string which may include wildcard characters. Descriptions of the system-wide objects whose names match the string 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:
|
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.