ListOfObjects (System function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Usage notes) |
||
Line 20: | Line 20: | ||
<ul><li>All errors result in request cancellation. | <ul><li>All errors result in request cancellation. | ||
<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. | ||
<li><var>ListOfObjects</var> is available in <var class="product">[[Sirius Mods| | <li><var>ListOfObjects</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 6.7 and later. | ||
</ul> | </ul> | ||
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.