$SyStat - Revision history

JDamon: Corrected the contents of %string

2021-08-10T22:38:06Z

Corrected the contents of %string

← Older revision		Revision as of 22:38, 10 August 2021
Line 12:		Line 12:
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>If the length of the returned value is exactly four, <var class="term">%string</var> is a binary number indicating an error code. <p>		<td>If the length of the returned value is exactly four, <var class="term">%string</var> is a binary number indicating an error code. <p>
	~~Otherwise, the first four (or eight if~~ <var>stat8</var> set to <code>8</code>) bytes of <var class="term">%string</var> is an unsigned binary number indicating the number of milliseconds the Online has been up. This provides a convenient number for calculating rates for the statistics. ~~</p>~~		If <var>stat8</var> is <i>not</i> set to <code>8</code>), the first four bytes of <var class="term">%string</var> is an unsigned binary number indicating the number of milliseconds the Online has been up. This provides a convenient number for calculating rates for the statistics. The next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by two bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.
	~~<p>~~
	The next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by 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>		If <var>stat8</var> is set to <code>8</code>, the first eight bytes of <var class="term">%string</var> is an unsigned binary number indicating the number of milliseconds the Online has been up. The next ten bytes contain the blank-padded word <code>SYSTEM8</code> followed by two bytes of binary 0. The actual data, in this case, then starts at offset 20 (byte number 21) in the result string.
			</p></td></tr>

	<tr><th>stat_list</th>		<tr><th>stat_list</th>

Alex at 20:19, 9 August 2021

2021-08-09T20:19:22Z

← Older revision		Revision as of 20:19, 9 August 2021
Line 7:		Line 7:

	==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>, [<span class="term">stat8</span>])
	</p>		</p>
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>If the length of the returned value is exactly four, <var class="term">%string</var> is a binary number indicating an error code. <p>		<td>If the length of the returned value is exactly four, <var class="term">%string</var> is a binary number indicating an error code. <p>
	Otherwise, the first four bytes of <var class="term">%string</var> is an unsigned binary number indicating the number of milliseconds the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>		Otherwise, the first four (or eight if <var>stat8</var> set to <code>8</code>) bytes of <var class="term">%string</var> is an unsigned binary number indicating the number of milliseconds the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
	<p>		<p>
	The next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by 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>		The next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by 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>		<tr><th>stat_list</th>
	<td>A string of blank-delimited words indicating the statistics to be returned. Each returned statistic is a 4-byte, unsigned, binary number; the offset of each statistic is ~~plus four~~ from the previous statistic, with the first statistic starting at offset 16 or byte number 17. 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>		<td>A string of blank-delimited words indicating the statistics to be returned. Each returned statistic is a 4 (or eight if <var>stat8</var> set to <code>8</code>) byte, unsigned, binary number; the offset of each statistic is 4 or 8 from the previous statistic, with the first statistic starting at offset 16 or byte number 17. 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>

			<tr><th>stat8</th>
			<td>A integer that, if set, can only have a value of <code>8</code>. If set to 8, the returned value starts with an 8-byte timestamp and each statistic occupies 8 bytes.

	</table>		</table>

JDamon: Correction on the location of each statistic

2018-02-11T17:56:12Z

Correction on the location of each statistic

← Older revision		Revision as of 17:56, 11 February 2018
Line 17:		Line 17:

	<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 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>		<td>A string of blank-delimited words indicating the statistics to be returned. Each returned statistic is a 4-byte, unsigned, binary number; the offset of each statistic is plus four from the previous statistic, with the first statistic starting at offset 16 or byte number 17. 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>		</table>

JAL: /* Syntax */ add "unsigned"

2016-10-04T14:51:46Z

Syntax: add "unsigned"

← Older revision		Revision as of 14:51, 4 October 2016
Line 12:		Line 12:
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>If the length of the returned value is exactly four, <var class="term">%string</var> is a binary number indicating an error code. <p>		<td>If the length of the returned value is exactly four, <var class="term">%string</var> is a binary number indicating an error code. <p>
	Otherwise, the first four bytes of <var class="term">%string</var> is a binary number indicating the number of milliseconds the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>		Otherwise, the first four bytes of <var class="term">%string</var> is an unsigned binary number indicating the number of milliseconds the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
	<p>		<p>
	The next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by 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>		The next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by 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>

JAL: clarify return value

2016-10-03T22:00:15Z

clarify return value

← Older revision		Revision as of 22:00, 3 October 2016
Line 5:		Line 5:

	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.~~

	==Syntax==		==Syntax==
Line 13:		Line 11:
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>If the length of the returned value is four, <var class="term">%string</var> is a binary number indicating an error code. Otherwise, the first four bytes of <var class="term">%string</var>		<td>If the length of the returned value is exactly four, <var class="term">%string</var> is a binary number indicating an error code. <p>
	is a binary number indicating the number of milliseconds the Online has been up. </td></tr>		Otherwise, the first four bytes of <var class="term">%string</var> is a binary number indicating the number of milliseconds the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
			<p>
			The next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by 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>		<tr><th>stat_list</th>
Line 26:		Line 26:
	-14 Result string would be longer than 255 bytes		-14 Result string would be longer than 255 bytes
	</p>		</p>

	~~==Usage notes==~~
	~~<ul>~~
	<li>The data returned by <var>$SyStat</var> is binary. If only four bytes are returned, they are an error code. Otherwise, the first four bytes are the number of milliseconds since the Online region was brought up. This provides a convenient number for calculating rates for the statistics. </li>

	<li>If more than four bytes are returned, the next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by two bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string. </li>
	~~</ul>~~

	==Example==		==Example==

JAL: clarify return value

2016-10-03T19:59:52Z

clarify return value

← Older revision		Revision as of 19:59, 3 October 2016
Line 13:		Line 13:
	<table>		<table>
	<tr><th>%string</th>		<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>		<td>If the length of the returned value is four, <var class="term">%string</var> is a binary number indicating an error code. Otherwise, the first four bytes of <var class="term">%string</var>
			is a binary number indicating the number of milliseconds the Online has been up. </td></tr>

	<tr><th>stat_list</th>		<tr><th>stat_list</th>
Line 20:		Line 21:

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

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The data returned by <var>$SyStat</var> 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.		<li>The data returned by <var>$SyStat</var> is binary. If only four bytes are returned, they are an error code. Otherwise, the first four bytes are the number of milliseconds since the Online region was brought up. This provides a convenient number for calculating rates for the statistics. </li>

	<li>~~When a positive error code is~~ returned, the next 10 bytes contain the blank-padded word <code>SYSTEM</code> followed by 2 bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.		<li>If more than four bytes are returned, the next ten bytes contain the blank-padded word <code>SYSTEM</code> followed by two bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string. </li>
	</ul>		</ul>

JAL: minor cleanup

2016-08-23T16:04:11Z

minor cleanup

← Older revision		Revision as of 16:04, 23 August 2016
Line 49:		Line 49:
	END		END
	</p>		</p>

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

	[[Category:$Functions\|$SyStat]]		[[Category:$Functions\|$SyStat]]

JAL: misc cleanup

2016-08-11T17:43:31Z

misc cleanup

← Older revision		Revision as of 17:43, 11 August 2016
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>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SyStat function.</p>		<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.

	The first 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 <var>$StatD</var> with the returned string. For more information about available statistics, see the <var class="book">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.

	==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>
	<p>		<table>
	<~~var class="term"~~>%string</~~var~~> ~~is made up of 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.</p>		<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>

JAL: /* Products authorizing {{PAGENAMEE}} */

2014-08-13T20:40:12Z

Products authorizing {{PAGENAMEE}}

← Older revision		Revision as of 20:40, 13 August 2014
Line 51:		Line 51:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius ~~$Functions~~]]		<li>[[List of $functions\|Sirius functions]]</li>
	</ul>		</ul>

	[[Category:$Functions\|$SyStat]]		[[Category:$Functions\|$SyStat]]

JAL at 22:19, 24 July 2013

2013-07-24T22:19:03Z

← Older revision		Revision as of 22:19, 24 July 2013
Line 8:		Line 8:
	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.

	The first 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 <var>$StatD</var> with the returned string. For more information about available statistics, see the <var class="~~product~~">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.		The first 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 <var>$StatD</var> with the returned string. For more information about available statistics, see the <var class="book">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.

	==Syntax==		==Syntax==