View source for $TkStat

{{DISPLAYTITLE:$TkStat}}
<span class="pageSubtitle">Retrieve task's statistics into string</span>

<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$TkStat</var> function.</p>

This function allows retrieval of a specific task's statistics into a string. 

==Syntax==
<p class="syntax"><span class="term">%string</span> = <span class="literal">$TkStat</span>(<span class="term">stat_list</span>, <span class="term">task_num</span>)
</p>

===Syntax terms===
<table>
<tr><th>%string</th> 
<td>A string of data. If the string is exactly four bytes, it contains a binary [[#Return codes|error code]]. 
<p>
Otherwise, the first four bytes contain the binary number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
<p>
The next ten bytes contain blanks, then follows two bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></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 <var>$StatD</var> with the returned string. 
<p>
For more information about available statistics, see the <var class="book">[[SirMon]]</var> M204wiki pages.</p> </td></tr>

<tr><th>task_num</th> 
<td>The task number of the task for which data is to be returned. The maintask is always task number 0. Other tasks are only available for Onlines running the [[MP/204]] feature.</td></tr>
</table>

===Return codes===
<p class="code"> -5   Required parameter not specified
-12   Invalid parameter (argument 2 > NMPSUBS)
-13   STAT not linked in
-14   Result string would be longer than 255 bytes
</p>

==Example==
The following program displays some totals for subtask 1:

<p class="code">Begin
%data IS STRING LEN 255
 
%data = $TkStat('CPU STDEQ LKWAIT', 1)
IF $LEN(%data) = 4 THEN
   PRINT '$TKSTAT ERROR... RC = ' WITH $Unbin(%data)
   STOP
END IF
 
PRINT 'CPU = ' WITH $Unbin( $Substr(%data, 17, 4) )
PRINT 'STDEQ = ' WITH $Unbin( $Substr(%data, 21, 4) )
PRINT 'LKWAIT = ' WITH $Unbin( $Substr(%data, 25, 4) ) 
End
</p>

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

[[Category:$Functions|$TkStat]]