$TkStatL: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (link repair) |
||
| (28 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$TkStatL}} | {{DISPLAYTITLE:$TkStatL}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Retrieve statistics for all tasks into $list</span> | ||
<p class=" | <p class="warn"><b>Note:</b> Many $functions are deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TkStatL function.</p> | ||
This function allows retrieval of statistics for all tasks into a $list. | This function allows retrieval of statistics for all tasks into a $list. | ||
| Line 8: | Line 8: | ||
The $TkStatL function accepts two argument and returns a numeric error code. | The $TkStatL function accepts two argument and returns a numeric error code. | ||
==Syntax== | |||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</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, which is the milliseconds since the online was brought up, or a negative error code.</td></tr> | |||
<table class=" | <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> | <tr><th>Byte 1-10</th> | ||
<td>Blanks</td></tr> | <td>Blanks</td></tr> | ||
<tr><th>Byte 11-12</th> | <tr><th>Byte 11-12</th> | ||
<td>Binary task number</td></tr> | <td>Binary task number</td></tr> | ||
<tr><th>Byte 13-</th> | <tr><th>Byte 13-</th> | ||
<td>Returned statistics | <td>Returned statistics</td></tr> | ||
</table> | |||
</td></tr> | </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 four bytes. This facilitates the use of [[$StatLD]] with the returned $list. | |||
<p> | |||
For more information about available statistics, see [[Task statistics displayed in SirMon]]. </p></td></tr> | |||
</table> | </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 | ||
<p class=" | -6 - Invalid $list identifier | ||
< | -13 - STAT not linked in | ||
</p> | </p> | ||
==Example== | |||
The following program displays some statistics for all tasks: | The following program displays some statistics for all tasks: | ||
<p class="code"> B | <p class="code">B | ||
%DATA IS STRING LEN 255 | |||
%LIST = $ListNew | |||
%DATA = $TkStatL(%LIST, 'CPU STDEQ LKWAIT') | |||
IF %DATA < 0 THEN | |||
PRINT '$TKSTATL ERROR... RC = ' WITH %DATA | |||
STOP | |||
END IF | |||
FOR %I FROM 1 TO $ListCnt(%LIST) | |||
%DATA = $ListInf(%LIST, %I) | |||
PRINT 'TASKNUM = ' WITH $UNBIN( $SUBSTR(%DATA, 11, 2) ) | |||
PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 13, 4) ) | |||
PRINT 'STDEQ = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) ) | |||
PRINT 'LKWAIT = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) ) | |||
PRINT | |||
END FOR | |||
END | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius | <li>[[List of $functions|Sirius functions]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$TkStatL]] | [[Category:$Functions|$TkStatL]] | ||
Latest revision as of 22:15, 27 November 2017
Retrieve statistics for all tasks into $list
Note: Many $functions are deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TkStatL function.
This function allows retrieval of statistics for all tasks into a $list.
The $TkStatL function accepts two argument and returns a numeric error code.
Syntax
%result = $TkStatL(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 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 four bytes. This facilitates the use of $StatLD with the returned $list.
For more information about available statistics, see Task statistics displayed in SirMon. |
Return 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
Example
The following program displays some statistics for all tasks:
B %DATA IS STRING LEN 255 %LIST = $ListNew %DATA = $TkStatL(%LIST, 'CPU STDEQ LKWAIT') IF %DATA < 0 THEN PRINT '$TKSTATL ERROR... RC = ' WITH %DATA STOP END IF FOR %I FROM 1 TO $ListCnt(%LIST) %DATA = $ListInf(%LIST, %I) PRINT 'TASKNUM = ' WITH $UNBIN( $SUBSTR(%DATA, 11, 2) ) PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 13, 4) ) PRINT 'STDEQ = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) ) PRINT 'LKWAIT = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) ) PRINT END FOR END