$UsStatL: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| Line 9: | Line 9: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$UsStatL</span>(<span class="term">list_identifier, stat_list, criterion) | <p class="syntax"><span class="term">%result</span> = <span class="literal">$UsStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, [<span class="term">criterion</span>]) | ||
</p> | </p> | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table | <table> | ||
<tr><th>%result</th> | <tr><th>%result</th> | ||
<td>Either a positive number, which is the milliseconds since the online was brought up, or a negative [[#Error codes|error code]].</td></tr> | <td>Either a positive number, which is the milliseconds since the online was brought up, or a negative [[#Error codes|error code]].</td></tr> | ||
| Line 20: | Line 20: | ||
<td>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: | <td>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: | ||
<table | <table> | ||
<tr>< | <tr><td>Byte 1-10</td> | ||
<td>Blank padded userid</td></tr> | <td>Blank padded userid</td></tr> | ||
<tr>< | |||
<tr><td>Byte 11-12</td> | |||
<td>Binary user number</td></tr> | <td>Binary user number</td></tr> | ||
<tr>< | |||
<td>Returned statistics | <tr><td>Byte 13-</td> | ||
</td></tr> | <td>Returned statistics</td></tr> | ||
</table> | </table> | ||
</td></tr> | </td></tr> | ||
| Line 38: | Line 39: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>ACCOUNT=acctid</th> | <tr><th><var>ACCOUNT=</var>acctid</th> | ||
<td>include only users with account ids matching <var class="term">acctid</var> (wildcards allowed).</td></tr> | <td>include only users with account ids matching <var class="term">acctid</var> (wildcards allowed).</td></tr> | ||
<tr><th>CFR=fid</th> | |||
<tr><th><var>CFR=</var>fid</th> | |||
<td>include only users holding or requesting critical file resources in files with filename matching <var class="term">fid</var> (wildcards allowed).</td></tr> | <td>include only users holding or requesting critical file resources in files with filename matching <var class="term">fid</var> (wildcards allowed).</td></tr> | ||
<tr><th>CHKP</th> | |||
<tr><th><var>CHKP</var></th> | |||
<td>include only users preventing checkpoints</td></tr> | <td>include only users preventing checkpoints</td></tr> | ||
<tr><th>FILE=filename</th> | |||
<tr><th><var>FILE=</var>filename</th> | |||
<td>include only users with <var class="term">filename</var> open.</td></tr> | <td>include only users with <var class="term">filename</var> open.</td></tr> | ||
<tr><th>IODEV=iodevnum</th> | |||
<tr><th><var>IODEV=</var>iodevnum</th> | |||
<td>include only users on IODEV <var class="term">iodevnum</var>.</td></tr> | <td>include only users on IODEV <var class="term">iodevnum</var>.</td></tr> | ||
<tr><th>PNAME=pname</th> | |||
<tr><th><var>PNAME=</var>pname</th> | |||
<td>include only users running procedures with names matching <var class="term">pname</var> (wildcards allowed).</td></tr> | <td>include only users running procedures with names matching <var class="term">pname</var> (wildcards allowed).</td></tr> | ||
<tr><th>SUBSYS=subsysid</th> | |||
<tr><th><var>SUBSYS=</var>subsysid</th> | |||
<td>include only users in subsystem <var class="term">subsysid</var> (wildcards allowed).</td></tr> | <td>include only users in subsystem <var class="term">subsysid</var> (wildcards allowed).</td></tr> | ||
<tr><th>TERMID=termid</th> | |||
<tr><th><var>TERMID=</var>termid</th> | |||
<td>include only users logged on terminals with ids matching <var class="term">termid</var> (wildcards allowed).</td></tr> | <td>include only users logged on terminals with ids matching <var class="term">termid</var> (wildcards allowed).</td></tr> | ||
<tr><th>USER=userid</th> | |||
<tr><th><var>USER=</var>userid</th> | |||
<td>include only users with userids matching <var class="term">userid</var> (wildcards allowed).</td></tr> | <td>include only users with userids matching <var class="term">userid</var> (wildcards allowed).</td></tr> | ||
<tr><th>WHAT=activity</th> | |||
<tr><th><var>WHAT=</var>activity</th> | |||
<td>include only users with current activity matching <var class="term">activity</var> (wildcards allowed). | <td>include only users with current activity matching <var class="term">activity</var> (wildcards allowed). | ||
</td></tr></table> | </td></tr></table> | ||
In actual fact, all users are always included in the output list, but the excluded users have the high order bit of their user numbers turned on. This tells [[$StatLD]] to exclude the users from the difference $list.</td></tr> | In actual fact, all users are always included in the output list, but the excluded users have the high order bit of their user numbers turned on. This tells <var>[[$StatLD]]</var> to exclude the users from the difference $list.</td></tr> | ||
</table> | </table> | ||
| Line 73: | Line 83: | ||
==Example== | ==Example== | ||
The following program displays some statistics for all users in subsystem SIRMON. | The following program displays some statistics for all users in subsystem <code>SIRMON</code>. | ||
<p class="code">b | <p class="code">b | ||
| Line 103: | Line 113: | ||
<li>[[Sirius $Functions]] | <li>[[Sirius $Functions]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$UsStatL]] | [[Category:$Functions|$UsStatL]] | ||
Revision as of 15:01, 12 April 2013
Retrieve statistics for set of users into $list
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStatL function is the UserStatistics class.
This function allows retrieval of statistics for a set of users into a $list.
The $UsStatL function accepts three arguments and returns a numeric error code.
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 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
-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