$SsStat: Difference between revisions
(Automatically generated page update) |
m (→Syntax: add "unsigned") |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Retrieve subsystem's statistics into string</span> | <span class="pageSubtitle">Retrieve subsystem's statistics into string</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the <var>$SsStat</var> function.</p> | ||
This function allows retrieval of a specific subsystem's statistics into a string. | This function allows retrieval of a specific subsystem's statistics into a string. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">% | <p class="syntax"><span class="term">%string</span> = <span class="literal">$SsStat</span>(<span class="term">stat_list</span>, <span class="term">subsystem_name</span>) | ||
</p> | </p> | ||
< | <table> | ||
<tr><th>%string</th> | |||
<td>A string of data. If the string contains exactly four bytes, it is a binary [[#Return codes|error code]]. | |||
<p> | |||
Otherwise, the first four bytes contain the unsigned binary number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. The next ten bytes contain the blank-padded file name, then follow two bytes containing the binary file number. This means that the actual statistical data starts at offset 16 (byte number 17) in the result string. </p></td></tr> | |||
The | <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 4 bytes. This facilitates the use of <var>$StatD</var> with the returned string. | |||
<p> | |||
For more information about available statistics, see the <var class="product">[[SirMon]]</var> M204wiki pages. </p></td></tr> | |||
<p class="code"> | <tr><th>subsystem_name</th> | ||
<td>The name of the subsystem for which data is to be returned. </td></tr> | |||
</table> | |||
===Return codes=== | |||
<p class="code"> -5 Required parameter not specified | |||
-12 Invalid parameter (argument 2 > NUSERS, | |||
or invalid name in stat_list) | |||
-13 STAT not linked in | |||
-14 Result string would be longer than 255 bytes | |||
-15 Subsystem not active | |||
</p> | </p> | ||
The following program displays some totals for subsystem SIRMON. | ==Example== | ||
The following program displays some totals for subsystem <code>SIRMON</code>. | |||
<p class="code"> B | <p class="code">B | ||
%DATA IS STRING LEN 255 | |||
%DATA = $SsStat('NUSER RESEVAL RESSWCH', 'SIRMON') | |||
IF $LEN(%DATA) = 4 THEN | |||
PRINT '$SSSTAT ERROR... RC = ' WITH - | |||
$UNBIN(%DATA) | |||
STOP | |||
END IF | |||
PRINT 'SUBSYSNAME = ' WITH $SUBSTR(%DATA, 5, 10) | |||
PRINT 'NUSER = ' WITH - | |||
$UNBIN( $SUBSTR(%DATA, 17, 4) ) | |||
PRINT 'RESEVAL = ' WITH - | |||
$UNBIN( $SUBSTR(%DATA, 21, 4) ) | |||
PRINT 'RESSWCH = ' WITH - | |||
$UNBIN( $SUBSTR(%DATA, 25, 4) ) | |||
END | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]] | <li>[[List of $functions|Sirius functions]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$SsStat]] | [[Category:$Functions|$SsStat]] | ||
Latest revision as of 14:53, 4 October 2016
Retrieve subsystem's statistics into string
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SsStat function.
This function allows retrieval of a specific subsystem's statistics into a string.
Syntax
%string = $SsStat(stat_list, subsystem_name)
| %string | A string of data. If the string contains exactly four bytes, it is a binary error code.
Otherwise, the first four bytes contain the unsigned binary number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. The next ten bytes contain the blank-padded file name, then follow two bytes containing the binary file number. This means that the actual statistical data starts at offset 16 (byte number 17) in the result string. |
|---|---|
| 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 4 bytes. This facilitates the use of $StatD with the returned string.
For more information about available statistics, see the SirMon M204wiki pages. |
| subsystem_name | The name of the subsystem for which data is to be returned. |
Return codes
-5 Required parameter not specified -12 Invalid parameter (argument 2 > NUSERS, or invalid name in stat_list) -13 STAT not linked in -14 Result string would be longer than 255 bytes -15 Subsystem not active
Example
The following program displays some totals for subsystem SIRMON.
B %DATA IS STRING LEN 255 %DATA = $SsStat('NUSER RESEVAL RESSWCH', 'SIRMON') IF $LEN(%DATA) = 4 THEN PRINT '$SSSTAT ERROR... RC = ' WITH - $UNBIN(%DATA) STOP END IF PRINT 'SUBSYSNAME = ' WITH $SUBSTR(%DATA, 5, 10) PRINT 'NUSER = ' WITH - $UNBIN( $SUBSTR(%DATA, 17, 4) ) PRINT 'RESEVAL = ' WITH - $UNBIN( $SUBSTR(%DATA, 21, 4) ) PRINT 'RESSWCH = ' WITH - $UNBIN( $SUBSTR(%DATA, 25, 4) ) END