$SsStatL: Difference between revisions
mNo edit summary |
m (link repair) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Retrieve statistics for set of subsystems into $list</span> | <span class="pageSubtitle">Retrieve statistics for set of subsystems into $list</span> | ||
<p class="warn"><b>Note: </b> | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SsStatL function.</p> | ||
This function allows retrieval of statistics for a set of subsystems into a $list. | This function allows retrieval of statistics for a set of subsystems into a $list. | ||
| Line 19: | Line 19: | ||
<tr><th>list_identifier</th> | <tr><th>list_identifier</th> | ||
<td>The identifier of the $list that is 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 that is 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 class=" | <table class="thJustBold"> | ||
<tr><th>Byte 1-10</th> | <tr><th>Byte 1-10</th> | ||
<td>Blank padded subsystem name</td></tr> | <td>Blank padded subsystem name</td></tr> | ||
| Line 31: | Line 31: | ||
<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 | <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 <var>[[$StatLD]]</var> with the returned $list. For more information about available statistics, see [[Subsystem statistics displayed in SirMon]]. </td></tr> | ||
<tr><th>criterion</th> | <tr><th>criterion</th> | ||
| Line 37: | Line 37: | ||
<table> | <table> | ||
<tr><th>FILE=filename</th> | <tr><th><var>FILE=</var>filename</th> | ||
<td> | <td>Include only subsystems that have opened file <var class="term">filename</var>.</td></tr> | ||
<tr><th>SUBSYS=subsysid</th> | <tr><th><var>SUBSYS=</var>subsysid</th> | ||
<td> | <td>Include only subsystems with names matching <var class="term">subsysid</var> (wildcards allowed).</td></tr> | ||
</table> | </table> | ||
<p> | <p> | ||
| Line 48: | Line 48: | ||
===Return codes=== | ===Return codes=== | ||
<p class="code"> -3 - No room to create $list items | <p class="code"> -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 | ||
| Line 87: | Line 86: | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]] | <li>[[List of $functions|Sirius functions]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$SsStatL]] | [[Category:$Functions|$SsStatL]] | ||
Latest revision as of 22:11, 27 November 2017
Retrieve statistics for set of subsystems into $list
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SsStatL function.
This function allows retrieval of statistics for a set of subsystems into a $list.
The $SsStatL function accepts three arguments and returns a numeric error code.
Syntax
%result = $SsStatL(list_identifier, stat_list, criterion)
Syntax terms
| %result | Either a positive number (milliseconds since the online was brought up) or a negative error code. | ||||||
|---|---|---|---|---|---|---|---|
| list_identifier | The identifier of the $list that is 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 Subsystem statistics displayed in SirMon. | ||||||
| criterion | A selection criterion that indicates which files are to be included in the output $list. The following criteria are allowed:
In actual fact, all files are always included in the output list, but the excluded subsystems have the high order bit of byte 11 turned on. This tells $StatLD to exclude the subsystems from the difference $list. |
Return codes
-3 - No room to create $list items (if LISTFC $SirParm parameter not set) -5 - Required parameter not specified -6 - Invalid $list identifier -12 - Invalid name in stat_list -13 - STAT not linked in -16 - Invalid selection criterion
Example
The following program displays some statistics for all subsystems.
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