ListOfObjects (System function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:System:ListOfObjects subtitle}}
{{Template:System:ListOfObjects subtitle}}
The <var>ListOfObjects</var> method returns a <var>[[Stringlist class|Stringlist]]</var> containing information about [[System_class#System-wide_objects|"system-wide objects"]]. <var>ListOfObjects</var> is a shared method.
The <var>ListOfObjects</var> method returns a <var>[[Stringlist class|Stringlist]]</var> containing information about [[System_class#System-wide_objects|"system-wide objects"]]. <var>ListOfObjects</var> is a [[Notation conventions for methods#Shared methods|shared methods]] method.


==Syntax==
==Syntax==
{{Template:System:ListOfObjects syntax}}
{{Template:System:ListOfObjects syntax}}
===Syntax terms===
===Syntax terms===
<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><var>%(System)</var></th>
 
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors|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><var class="nobr">%(System)</var></th>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|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>string</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">string</var> pattern(s) are returned to the <var class="term">%sl</var> <var>Stringlist</var>.
<td>An optional identifying string which may include wildcard characters.  Descriptions of the system-wide objects whose names match the pattern(s) in <var class="term">string</var> are returned to the <var class="term">%sl</var> <var>Stringlist</var>.
<p>This argument defaults to an asterisk (<tt>*</tt>), that is, all system-wide objects, and its eligible wildcard characters are shown below:</p>
<p>
<ul><li><code>*</code> Matches any group of 0 or more characters
This argument defaults to an asterisk (<tt>*</tt>), that is, all system-wide objects, and its eligible wildcard characters are shown below:</p>
<li><code>?</code> Matches any single character
<table class="noVar">
<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>
<tr><th>*</th>
<td>Matches any group of 0 or more characters</td></tr>
 
<tr><th>?</th>
<td>Matches any single character</td></tr>
 
<tr><th>"</th>
<td>An escape, which means the next character is treated literally, even if it is a double quotation mark (<tt>"</tt>), question mark (<tt>?</tt>), or asterisk (<tt>*</tt>)</td></tr>
</table></td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
<ul><li>All errors result in request cancellation.
<ul>
<li>The format of the output Stringlist is:
<table>
<tr class="head><th>Columns</th><th>Contents</th></tr>
<tr><td>1-10</td><td>The userid of the user that saved the system object.</td></tr>
<tr><td>12-28</td><td>The date and time the object was saved in YY/MM/DD HH:MI:SS format.</td></tr>
<tr><td>30-52</td><td>The name of the subsystem with which the object is associated. Since system objects are not associated with a subsystem, this is always blanks.</td></tr>
<tr><td>54-</td><td>The name of the system global.</td></tr>
 
</table>
<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|Sirius Mods]]</var> Version 6.7 and later.
</ul>
</ul>
==Examples==


==See also==
==See also==
{{Template:System:ListOfObjects footer}}
{{Template:System:ListOfObjects footer}}

Latest revision as of 00:26, 16 February 2014

List of system objects (System class)

The ListOfObjects method returns a Stringlist containing information about "system-wide objects". ListOfObjects is a shared methods 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.
string An optional identifying string which may include wildcard characters. Descriptions of the system-wide objects whose names match the pattern(s) in string 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

  • The format of the output Stringlist is:
    ColumnsContents
    1-10The userid of the user that saved the system object.
    12-28The date and time the object was saved in YY/MM/DD HH:MI:SS format.
    30-52The name of the subsystem with which the object is associated. Since system objects are not associated with a subsystem, this is always blanks.
    54-The name of the system global.
  • All errors result in request cancellation.
  • The items placed on the target Stringlist are put there in no particular order.

See also