$TkStatL: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Retrieve statistics for all tasks into $list<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Retrieve statistics for all tasks into $list<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">Most Sirius $functions have been 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 9: | Line 9: | ||
The first argument is 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: | The first argument is 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="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>Byte 1-10</th> | <tr><th>Byte 1-10</th> | ||
| Line 16: | Line 17: | ||
<tr><th>Byte 13-</th> | <tr><th>Byte 13-</th> | ||
<td>Returned statistics | <td>Returned statistics | ||
</td></tr></table> | </td></tr> | ||
</table> | |||
The second argument is 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"''. | |||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %RESULT = $TkStatL(list_identifier, stat_list, criterion) | <p class="syntax"><section begin="syntax" /> %RESULT = $TkStatL(list_identifier, stat_list, criterion) | ||
| Line 26: | Line 28: | ||
</p> | </p> | ||
<p class="caption">%RESULT is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p> | <p class="caption">%RESULT is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p> | ||
<p class="code"> | <p class="code"> | ||
-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 | -13 - STAT not linked in | ||
</p> | </p> | ||
<p class="caption">$TkStatL return codes | <p class="caption">$TkStatL return codes | ||
</p> | </p> | ||
The following program displays some statistics for all tasks: | |||
<p class="code"> B | <p class="code"> B | ||
| Line 47: | Line 48: | ||
%DATA = $TkStatL(%LIST, 'CPU STDEQ LKWAIT') | %DATA = $TkStatL(%LIST, 'CPU STDEQ LKWAIT') | ||
IF %DATA < 0 THEN | IF %DATA < 0 THEN | ||
PRINT '$TKSTATL ERROR... RC = ' WITH %DATA | |||
STOP | |||
END IF | END IF | ||
FOR %I FROM 1 TO $ListCnt(%LIST) | 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 FOR | ||
END | END | ||
</p> | </p> | ||
<ul class="smallAndTightList"> | |||
<li>[[Sirius $Functions]] | |||
</ul> | </ul> | ||
<p class="caption">Products authorizing $TkStatL | <p class="caption">Products authorizing $TkStatL | ||
</p> | </p> | ||
[[Category:$Functions|$TkStatL]] | [[Category:$Functions|$TkStatL]] | ||
Revision as of 20:45, 8 February 2011
<section begin="desc" />Retrieve statistics for all tasks into $list<section end="desc" />
Most Sirius $functions have been 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.
The first argument is 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:
| Byte 1-10 | Blanks |
|---|---|
| Byte 11-12 | Binary task number |
| Byte 13- | Returned statistics |
The second argument is 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".
Syntax
<section begin="syntax" /> %RESULT = $TkStatL(list_identifier, stat_list, criterion) <section end="syntax" />
$TkStatL Function
%RESULT is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.
-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
$TkStatL return codes
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
Products authorizing $TkStatL