View source for $SsStatL

{{DISPLAYTITLE:$SsStatL}}
<span class="pageSubtitle">Retrieve statistics for set of subsystems into $list</span>

<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. 

The <var>$SsStatL</var> function accepts three arguments and returns a numeric error code. 

==Syntax==
<p class="syntax"><span class="term">%result</span> = <span class="literal">$SsStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)
</p>

===Syntax terms===
<table>
<tr><th>%result</th> 
<td>Either a positive number (milliseconds since the online was brought up) or a negative error code.</td></tr>

<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:
<table class="thJustBold">
<tr><th>Byte 1-10</th>
<td>Blank padded subsystem name</td></tr>

<tr><th>Byte 11-12</th>
<td>Always 0</td></tr>

<tr><th>Byte 13-</th>
<td>Returned statistics</td></tr>
</table></td></tr>

<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 <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> 
<td>A selection criterion that indicates which files are to be included in the output $list. The following criteria are allowed:

<table>
<tr><th><var>FILE=</var>filename</th>
<td>Include only subsystems that have opened file <var class="term">filename</var>.</td></tr>

<tr><th><var>SUBSYS=</var>subsysid</th>
<td>Include only subsystems with names matching <var class="term">subsysid</var> (wildcards allowed).</td></tr>
</table>
<p>
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 <var>$StatLD</var> to exclude the subsystems from the difference $list. </p></td></tr>
</table>

===Return codes===
<p class="code"> -3 - No room to create $list items (if LISTFC <var>$SirParm</var> 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
</p>

==Example==
The following program displays some statistics for all subsystems.

<p class="code">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
</p>

==Products authorizing {{PAGENAMEE}}== 
<ul class="smallAndTightList">
<li>[[List of $functions|Sirius functions]]
</ul>

[[Category:$Functions|$SsStatL]]