$SyStat: Difference between revisions
Jump to navigation
Jump to search
m (misc cleanup) |
|||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Retrieve system statistics into string</span> | <span class="pageSubtitle">Retrieve system statistics into string</span> | ||
<p class="warn"><b>Note: </b> | <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>$SyStat</var> function.</p> | ||
This function allows retrieval of system statistics into a string. | This function allows retrieval of system statistics into a string. | ||
The <var>$SyStat</var> function accepts one argument and returns a string made up of an error code and returned statistics. | The <var>$SyStat</var> function accepts one argument and returns a string made up of an error code and returned statistics. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%string</span> = <span class="literal">$SyStat</span>(<span class="term">stat_list</span>) | <p class="syntax"><span class="term">%string</span> = <span class="literal">$SyStat</span>(<span class="term">stat_list</span>) | ||
</p> | </p> | ||
< | <table> | ||
< | <tr><th>%string</th> | ||
<td>Binary data, the first 4 bytes of which is an error code. If the error code is negative, <var class="term">%string</var> will only be 4 bytes long.</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 a multiple of 4 bytes. This facilitates the use of <var>$StatD</var> with the returned string. For more information about available statistics, see [[System statistics displayed in SirMon]].</td></tr> | |||
</table> | |||
===Return codes=== | ===Return codes=== | ||
| Line 33: | Line 36: | ||
The following program displays some totals for system statistics. | The following program displays some totals for system statistics. | ||
<p class="code">B | <p class="code">B | ||
%DATA IS STRING LEN 255 | %DATA IS STRING LEN 255 | ||
| Line 45: | Line 47: | ||
PRINT 'DKIO = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) ) | PRINT 'DKIO = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) ) | ||
PRINT 'SVIO = ' WITH $UNBIN( $SUBSTR(%DATA, 25, 4) ) | PRINT 'SVIO = ' WITH $UNBIN( $SUBSTR(%DATA, 25, 4) ) | ||
END | END | ||
</p> | </p> | ||
Revision as of 17:43, 11 August 2016
Retrieve system statistics into string
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SyStat function.
This function allows retrieval of system statistics into a string.
The $SyStat function accepts one argument and returns a string made up of an error code and returned statistics.
Syntax
%string = $SyStat(stat_list)
| %string | Binary data, the first 4 bytes of which is an error code. If the error code is negative, %string will only be 4 bytes long. |
|---|---|
| stat_list | A string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is a multiple of 4 bytes. This facilitates the use of $StatD with the returned string. For more information about available statistics, see System statistics displayed in SirMon. |
Return codes
-5 - Required parameter not specified -12 - Invalid name in stat_list -13 - STAT not linked in -14 - Result string would be longer than 255 bytes
Usage notes
- The data returned by $SyStat is binary, with the first 4 bytes containing an error code. If the error code is negative, only 4 bytes are returned. If the error code is positive, it contains the number of milliseconds since the online region was brought up. This provides a convenient number for calculating rates for the statistics.
- When a positive error code is returned, the next 10 bytes contain the blank-padded word
SYSTEMfollowed by 2 bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.
Example
The following program displays some totals for system statistics.
B %DATA IS STRING LEN 255 %DATA = $SyStat('CPU DKIO SVIO') IF $LEN(%DATA) = 4 THEN PRINT '$SYSTAT ERROR... RC = ' WITH $UNBIN(%DATA) STOP END IF PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) ) PRINT 'DKIO = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) ) PRINT 'SVIO = ' WITH $UNBIN( $SUBSTR(%DATA, 25, 4) ) END