ListOfObjects (System function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Automatically generated page update) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 9: | Line 9: | ||
<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 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> | <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> | ||
| Line 30: | Line 30: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <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>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. | ||
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
| %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 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:
|
Usage notes
- The format of the output Stringlist is:
Columns Contents 1-10 The userid of the user that saved the system object. 12-28 The date and time the object was saved in YY/MM/DD HH:MI:SS format. 30-52 The 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.