ListOfGlobals (System function): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
(Automatically generated page update) |
||
| (20 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:System:ListOfGlobals subtitle}} | {{Template:System:ListOfGlobals subtitle}} | ||
The <var>ListOfGlobals</var> shared function returns a <var>[[Stringlist_class|Stringlist]]</var> containing information about [[System class#System and subsystem globals and strings|system-wide globals]]. | |||
==Syntax== | ==Syntax== | ||
{{Template:System:ListOfGlobals syntax}} | {{Template:System:ListOfGlobals syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%sl</th><td>The <var>[[Stringlist_class|Stringlist]]</var> variable that contains the data about the globals selected according to the pattern given in the <var class="term">string</var> argument.</td></tr> | ||
<tr><th>(System)</th> | |||
<td>The class name in parentheses denotes a shared method. ListOfGlobals can also be invoked via a System object variable, which may be | <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>ListOfGlobals</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>< | <td>A string that identifies the name of the global(s) to be listed. This can be a specific name or a name containing wildcards. This optional argument defaults to an asterisk (<tt>*</tt>), that is, all globals. | ||
<p> | |||
The eligible wildcard characters are:</p> | |||
<table class="noVar"> | |||
<tr><th>*</th> | |||
<td>Matches any group of 0 or more characters</td></tr> | |||
<tr><th>?</th> | |||
<td>Matches any single characters</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. | |||
<li>The items placed on the target <var class="term">sl</var> are put there in no particular order. | |||
<li>The data returned to each item of the <var>Stringlist</var> is in character format with the following contents: | |||
<ul> | |||
<li>Bytes 1-10 — Userid that last set the global. | |||
<li>Bytes 12-28 — Date and time global last set, in <code>YY/MM/DD HH:MI:SS</code> format. | |||
<li>Bytes 30-53 — <var>Null</var> for <var>system</var> globals (<var>Subsystem</var> context for global). | |||
<li>Bytes 54- — Global name. | |||
</ul> | |||
<li>You can map to an image the information in each <var>Stringlist</var> item (described in the previous bullet item) as follows | |||
<p class="code">image desc | |||
userid is string len 11 | |||
dateTime is string len 18 | |||
subsystem is string len 24 | |||
name is string len 255 | |||
end image | |||
</p> | |||
Note that the image items are one byte longer than the item lengths indicated in the previous bullet. Those bytes would be blank, so standard trailing-blank stripping for image items will cause that extra blank to be stripped. The above image could then be used to map the entries, as follows: | |||
<p class="code">%sl is object stringList | |||
%i is float | |||
%sl = %(system):listOfGlobals | |||
prepare image desc | |||
%sl:bindImage('DESC') | |||
for %i from 1 to %sl:count | |||
%sl:getImage(%i) | |||
print %desc:userid and %desc:dateTime and %desc:name | |||
end for | |||
</p> | |||
</ul> | |||
==Examples== | ==Examples== | ||
The following statement prints the description of all system globals that end in <code>.XML</code>: | |||
<p class="code">%(system):listOfGlobals('*.XML'):print | |||
</p> | |||
==See also== | ==See also== | ||
{{Template:System:ListOfGlobals footer}} | {{Template:System:ListOfGlobals footer}} | ||
Latest revision as of 00:26, 16 February 2014
List of system globals (System class)
The ListOfGlobals shared function returns a Stringlist containing information about system-wide globals.
Syntax
%sl = %(System):ListOfGlobals[( [string])]
Syntax terms
| %sl | The Stringlist variable that contains the data about the globals selected according to the pattern given in the string argument. | ||||||
|---|---|---|---|---|---|---|---|
| %(System) | The class name in parentheses denotes a shared method. ListOfGlobals can also be invoked via a System object variable, which may be Null. | ||||||
| string | A string that identifies the name of the global(s) to be listed. This can be a specific name or a name containing wildcards. This optional argument defaults to an asterisk (*), that is, all globals.
The eligible wildcard characters are:
|
Usage notes
- All errors result in request cancellation.
- The items placed on the target sl are put there in no particular order.
- The data returned to each item of the Stringlist is in character format with the following contents:
- Bytes 1-10 — Userid that last set the global.
- Bytes 12-28 — Date and time global last set, in
YY/MM/DD HH:MI:SSformat. - Bytes 30-53 — Null for system globals (Subsystem context for global).
- Bytes 54- — Global name.
- You can map to an image the information in each Stringlist item (described in the previous bullet item) as follows
image desc userid is string len 11 dateTime is string len 18 subsystem is string len 24 name is string len 255 end image
Note that the image items are one byte longer than the item lengths indicated in the previous bullet. Those bytes would be blank, so standard trailing-blank stripping for image items will cause that extra blank to be stripped. The above image could then be used to map the entries, as follows:
%sl is object stringList %i is float %sl = %(system):listOfGlobals prepare image desc %sl:bindImage('DESC') for %i from 1 to %sl:count %sl:getImage(%i) print %desc:userid and %desc:dateTime and %desc:name end for
Examples
The following statement prints the description of all system globals that end in .XML:
%(system):listOfGlobals('*.XML'):print