$UsStatL: Difference between revisions
m (→Error codes: added -1) |
mNo edit summary |
||
Line 3: | Line 3: | ||
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStatL function is the [[UserStatistics class]].</p> | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStatL function is the [[UserStatistics class]].</p> | ||
==Syntax== | ==Syntax== | ||
Line 15: | Line 11: | ||
<table> | <table> | ||
<tr><th>%result</th> | <tr><th>%result</th> | ||
<td>Either a positive number, which is the milliseconds since the | <td>Either a positive number, which is the milliseconds since the Online was brought up, or a negative [[#Error codes|error code]].</td></tr> | ||
<tr><th>list_identifier</th> | <tr><th>list_identifier</th> | ||
Line 33: | Line 29: | ||
<tr><th>stat_list</th> | <tr><th>stat_list</th> | ||
<td>A string of blank delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatLD with the returned $list. For more information about available statistics, see the <var class=" | <td>A string of blank delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatLD with the returned $list. For more information about available statistics, see the <var class="book">[http://m204wiki.rocketsoftware.com/images/5/5e/MonrNew.pdf Rocket M204 SirMon User's Guide]</var>. </td></tr> | ||
<tr><th>criterion</th> | <tr><th>criterion</th> | ||
Line 40: | Line 36: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><var>ACCOUNT=</var>acctid</th> | <tr><th><var>ACCOUNT=</var>acctid</th> | ||
<td> | <td>Include only users with account IDs matching <var class="term">acctid</var> (wildcards allowed).</td></tr> | ||
<tr><th><var>CFR=</var>fid</th> | <tr><th><var>CFR=</var>fid</th> | ||
<td> | <td>Include only users holding or requesting critical file resources in files with <var class="term">filename</var> matching <var class="term">fid</var> (wildcards allowed).</td></tr> | ||
<tr><th><var>CHKP</var></th> | <tr><th><var>CHKP</var></th> | ||
<td> | <td>Include only users preventing checkpoints.</td></tr> | ||
<tr><th><var>FILE=</var>filename</th> | <tr><th><var>FILE=</var>filename</th> | ||
<td> | <td>Include only users with <var class="term">filename</var> open.</td></tr> | ||
<tr><th><var>IODEV=</var>iodevnum</th> | <tr><th><var>IODEV=</var>iodevnum</th> | ||
<td> | <td>Include only users on IODEV <var class="term">iodevnum</var>.</td></tr> | ||
<tr><th><var>PNAME=</var>pname</th> | <tr><th><var>PNAME=</var>pname</th> | ||
<td> | <td>Include only users running procedures with names matching <var class="term">pname</var> (wildcards allowed).</td></tr> | ||
<tr><th><var>SUBSYS=</var>subsysid</th> | <tr><th><var>SUBSYS=</var>subsysid</th> | ||
<td> | <td>Include only users in subsystem <var class="term">subsysid</var> (wildcards allowed).</td></tr> | ||
<tr><th><var>TERMID=</var>termid</th> | <tr><th><var>TERMID=</var>termid</th> | ||
<td> | <td>Include only users logged on terminals with ids matching <var class="term">termid</var> (wildcards allowed).</td></tr> | ||
<tr><th><var>USER=</var>userid</th> | <tr><th><var>USER=</var>userid</th> | ||
<td> | <td>Include only users with userids matching <var class="term">userid</var> (wildcards allowed).</td></tr> | ||
<tr><th><var>WHAT=</var>activity</th> | <tr><th><var>WHAT=</var>activity</th> | ||
<td> | <td>Include only users with current activity matching <var class="term">activity</var> (wildcards allowed). | ||
</td></tr></table> | </td></tr></table> | ||
Line 74: | Line 70: | ||
===Error codes=== | ===Error codes=== | ||
<p class="code"> -1 — | <p class="code"> -1 — User is not waiting. (The wait type of a running user is -1.) | ||
-3 — No room to create $list items (if LISTFC <var>$SirParm</var> parameter not set) | -3 — No room to create $list items (if LISTFC <var>$SirParm</var> parameter not set). | ||
-5 — Required parameter not specified | -5 — Required parameter not specified. | ||
-6 — Invalid $list identifier | -6 — Invalid $list identifier. | ||
-13 — STAT not linked in | -13 — STAT not linked in. | ||
-16 — Invalid selection criterion | -16 — Invalid selection criterion. | ||
</p> | </p> | ||
Revision as of 16:21, 18 March 2014
Retrieve statistics for set of users into $list
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStatL function is the UserStatistics class.
Syntax
%result = $UsStatL(list_identifier, stat_list, [criterion])
Syntax terms
%result | Either a positive number, which is the milliseconds since the Online was brought up, or a negative error code. | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
list_identifier | The identifier of the $list to receive the results. The current contents of the $list are deleted and replaced with the requested statistics. The format of each $list item is:
| ||||||||||||||||||||
stat_list | A string of blank delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatLD with the returned $list. For more information about available statistics, see the Rocket M204 SirMon User's Guide. | ||||||||||||||||||||
criterion | A selection criterion that indicates which users are to be included in the output $list. The following criteria are allowed:
|
Error codes
-1 — User is not waiting. (The wait type of a running user is -1.) -3 — No room to create $list items (if LISTFC $SirParm parameter not set). -5 — Required parameter not specified. -6 — Invalid $list identifier. -13 — STAT not linked in. -16 — Invalid selection criterion.
Example
The following program displays some statistics for all users in subsystem SIRMON
.
b %data is string len 255 %list1 = $ListNew %list2 = $ListNew %list3 = $ListNew %time1 = $UsStatL(%list1, 'IODEV CPU') Pause 1 %time2 = $UsStatL(%list2, 'IODEV CPU','SUBSYS=SIRMON') %rc = $StatLD(%list1, %list2, %list3, 'N N', %time2 - %time1) For %i from 1 to $ListCnt(%list3) %data = $ListInf(%list3, %i) Text userid = { $substr(%data,1,10) } - usernum = { $unbin($substr(%data,11,2)) } - iodev = { $unbin($substr(%data,13,4)) } - cpu total = { $unbin($substr(%data,17,4)) } End Text End For End