$SsStat - Revision history

JAL: /* Syntax */ add "unsigned"

2016-10-04T14:53:27Z

Syntax: add "unsigned"

← Older revision		Revision as of 14:53, 4 October 2016
Line 13:		Line 13:
	<td>A string of data. If the string contains exactly four bytes, it is a binary [[#Return codes\|error code]].		<td>A string of data. If the string contains exactly four bytes, it is a binary [[#Return codes\|error code]].
	<p>		<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. 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>		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>

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

JAL: clarify return value

2016-10-03T21:48:47Z

clarify return value

← Older revision		Revision as of 21:48, 3 October 2016
Line 11:		Line 11:
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string of ~~binary~~ data. If the string contains exactly four bytes, it is an [[#Return codes\|error code]].		<td>A string of data. If the string contains exactly four bytes, it is a binary [[#Return codes\|error code]].
	<p>		<p>
	Otherwise, the first four bytes contain the 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>		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. 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>

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

JAL: clarify return value

2016-10-03T20:44:38Z

clarify return value

← Older revision		Revision as of 20:44, 3 October 2016
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="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SsStat function.</p>		<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.

	~~The $SsStat function accepts two arguments 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 $StatD 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 second argument is the subsystem name for which data is to be returned.~~

	==Syntax==		==Syntax==
	<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 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>
	<p>%string ~~is made up~~ of 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~~.</p>		<table>
			<tr><th>%string</th>
			<td>A string of binary data. If the string contains exactly four bytes, it is an [[#Return codes\|error code]].
			<p>
			Otherwise, the first four bytes contain the 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>

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

			<tr><th>subsystem_name</th>
			<td>The name of the subsystem for which data is to be returned. </td></tr>
			</table>

	===Return codes===		===Return codes===
	<p class="code"> -5 - Required parameter not specified		<p class="code"> -5 Required parameter not specified
	-12 - Invalid parameter (argument 2 > NUSERS,		-12 Invalid parameter (argument 2 > NUSERS,
	or invalid name in stat_list)		or 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
	-15 - Subsystem not active		-15 Subsystem not active
	</p>		</p>

	~~==Usage notes==~~
	~~<ul>~~
	<li>The data returned by $SsStat is binary; the first four bytes contain a return code. If the return code is negative, only four bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics. With a positive return code, the next ten bytes contain the blank padded file name, followed by two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.
	~~</ul>~~

	==Example==		==Example==
	The following program displays some totals for subsystem SIRMON.		The following program displays some totals for subsystem <code>SIRMON</code>.

	<p class="code">B		<p class="code">B
Line 60:		Line 62:
	<li>[[List of $functions\|Sirius functions]]		<li>[[List of $functions\|Sirius functions]]
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

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

JALWiccan: Automatically generated page update

2014-10-10T22:53:11Z

Automatically generated page update

← Older revision		Revision as of 22:53, 10 October 2014
Line 58:		Line 58:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius functions]]		<li>[[List of $functions\|Sirius functions]]
	</ul>		</ul>
	<p>		<p>

JAL: /* Syntax */

2013-07-23T22:13:29Z

Syntax

← Older revision		Revision as of 22:13, 23 July 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<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 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>
	<p>%~~STRING~~ is made up of 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.</p>		<p>%string is made up of 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.</p>

	The data returned by $SsStat is binary; the first four bytes contain a return code. If the return code is negative, only four bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics. With a positive return code, ~~the next ten bytes contain the blank padded file~~ name~~, followed by two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17~~) in ~~the result~~ string.		===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 class~~=~~"code">~~		==Usage notes==
	~~-5 - Required parameter not specified~~		<ul>
	~~-12 - Invalid parameter (argument 2 > NUSERS,~~		<li>The data returned by $SsStat is binary; the first four bytes contain a return code. If the return code is negative, only four bytes are returned. If the return code is positive, it contains a number of milliseconds that the online has been up. This provides a convenient number for calculating rates for the statistics. With a positive return code, the next ten bytes contain the blank padded file name, followed by two bytes containing the binary file number. This means that the actual data starts at offset 16 (byte number 17) in the result string.
	~~or invalid name in stat_list)~~		</ul>
	~~-13 - STAT not linked in~~
	~~-14 - Result string would be longer than 255 bytes~~
	~~-15 - Subsystem not active~~
	</p>
	<~~p class="caption"~~>$SsStat return ~~codes~~
	</p>

			==Example==
	The following program displays some totals for subsystem SIRMON.		The following program displays some totals for subsystem SIRMON.

	<p class="code"> B		<p class="code">B

	%DATA IS STRING LEN 255		%DATA IS STRING LEN 255

	%DATA = $SsStat('NUSER RESEVAL RESSWCH', 'SIRMON')		%DATA = $SsStat('NUSER RESEVAL RESSWCH', 'SIRMON')
	IF $LEN(%DATA) = 4 THEN		IF $LEN(%DATA) = 4 THEN
	PRINT '$SSSTAT ERROR... RC = ' WITH -		PRINT '$SSSTAT ERROR... RC = ' WITH -
	$UNBIN(%DATA)		$UNBIN(%DATA)
	STOP		STOP
	END IF		END IF

	PRINT 'SUBSYSNAME = ' WITH $SUBSTR(%DATA, 5, 10)		PRINT 'SUBSYSNAME = ' WITH $SUBSTR(%DATA, 5, 10)
	PRINT 'NUSER = ' WITH -		PRINT 'NUSER = ' WITH -
	$UNBIN( $SUBSTR(%DATA, 17, 4) )		$UNBIN( $SUBSTR(%DATA, 17, 4) )
	PRINT 'RESEVAL = ' WITH -		PRINT 'RESEVAL = ' WITH -
	$UNBIN( $SUBSTR(%DATA, 21, 4) )		$UNBIN( $SUBSTR(%DATA, 21, 4) )
	PRINT 'RESSWCH = ' WITH -		PRINT 'RESSWCH = ' WITH -
	$UNBIN( $SUBSTR(%DATA, 25, 4) )		$UNBIN( $SUBSTR(%DATA, 25, 4) )

	END		END
	</p>		</p>

JALWiccan: Automatically generated page update

2013-07-19T18:59:30Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
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="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SsStat function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SsStat 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.

JALWiccan: Automatically generated page update

2013-04-16T02:00:22Z

Automatically generated page update

← Older revision		Revision as of 02:00, 16 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%STRING</span> = <span class="literal">$SsStat</span>(<span class="term">stat_list</span>, subsystem_name)		<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>
	<p>%STRING is made up of 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.</p>		<p>%STRING is made up of 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.</p>

JALWiccan: Automatically generated page update

2013-04-16T01:35:25Z

Automatically generated page update

← Older revision		Revision as of 01:35, 16 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%STRING</span> = <span class="literal">$SsStat</span>(stat_list, subsystem_name)		<p class="syntax"><span class="term">%STRING</span> = <span class="literal">$SsStat</span>(<span class="term">stat_list</span>, subsystem_name)
	</p>		</p>
	<p>%STRING is made up of 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.</p>		<p>%STRING is made up of 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.</p>

JALWiccan: Automatically generated page update

2013-04-12T23:40:11Z

Automatically generated page update

← Older revision		Revision as of 23:40, 12 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax">%STRING = $SsStat(stat_list, subsystem_name)		<p class="syntax"><span class="term">%STRING</span> = <span class="literal">$SsStat</span>(stat_list, subsystem_name)
	</p>		</p>
	<p>%STRING is made up of 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.</p>		<p>%STRING is made up of 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.</p>

JALWiccan: Automatically generated page update

2013-04-10T18:17:48Z

Automatically generated page update

← Older revision		Revision as of 18:17, 10 April 2013
Line 13:		Line 13:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>%STRING = $SsStat(stat_list, subsystem_name)		<p class="syntax">%STRING = $SsStat(stat_list, subsystem_name)
	~~<section end="syntax" />~~</p>		</p>
	<p>%STRING is made up of 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.</p>		<p>%STRING is made up of 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.</p>