$TkStatL: Difference between revisions
m (link repair) |
|||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Retrieve statistics for all tasks into $list</span> | <span class="pageSubtitle">Retrieve statistics for all tasks into $list</span> | ||
<p class="warn"><b>Note: </b> | <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 33: | Line 33: | ||
<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 | <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> | <p> | ||
For more information about available statistics, see | For more information about available statistics, see [[Task statistics displayed in SirMon]]. </p></td></tr> | ||
</table> | </table> | ||
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