$UsStat - Revision history

DCameron: /* Return codes */

2018-02-28T11:00:30Z

Return codes

← Older revision		Revision as of 11:00, 28 February 2018
Line 30:		Line 30:
	===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)
	-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

JAL: link repair

2017-11-27T22:34:44Z

link repair

← Older revision		Revision as of 22:34, 27 November 2017
Line 22:		Line 22:
	<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.		<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>		<p>
	For more information about available statistics, see ~~the <var class="product">~~[[~~SirMon#SirMon topics\|~~SirMon]]~~</var> wiki pages~~. </p></td></tr>		For more information about available statistics, see [[User statistics displayed in SirMon]]. </p></td></tr>

	<tr><th>user_num</th>		<tr><th>user_num</th>

JAL: /* Syntax */ add "unsigned"

2016-10-04T14:52:43Z

Syntax: add "unsigned"

← Older revision		Revision as of 14:52, 4 October 2016
Line 15:		Line 15:
	<td>A string of data. If the string is exactly four bytes, it contains a binary [[#Return codes\|error code]].		<td>A string of data. If the string is exactly four bytes, it contains 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. </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. </p>
	<p>		<p>
	The next ten bytes contain the user ID, then follows two bytes containing the binary user number. 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 user ID, then follows two bytes containing the binary user number. 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-03T21:51:36Z

clarify return value

← Older revision		Revision as of 21:51, 3 October 2016
Line 5:		Line 5:

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

	~~The <var>$UsStat</var> function accepts two argument and returns a string made up of an error code and returned statistics.~~

	==Syntax==		==Syntax==

JAL: clarify return value

2016-10-03T21:51:04Z

clarify return value

← Older revision		Revision as of 21:51, 3 October 2016
Line 15:		Line 15:
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string ~~containing binary~~ data. If the string is exactly four bytes, it contains an [[#Return codes\|error code]].		<td>A string of data. If the string is exactly four bytes, it contains 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. </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>		<p>
	The next ten bytes contain the user ID, then follows two bytes containing the binary user number. 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 user ID, then follows two bytes containing the binary user number. 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-03T20:27:44Z

clarify return value

← Older revision		Revision as of 20:27, 3 October 2016
Line 15:		Line 15:
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string containing binary data, the ~~first 4~~ bytes ~~of which is~~ an [[#Return codes\|error code]].		<td>A string containing binary data. If the string is exactly four bytes, it contains an [[#Return codes\|error code]].
	<p>		<p>
	If the ~~error code is negative, <var class="term">%string</var> will only be 4~~ bytes ~~long. If~~ the ~~error 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. </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. </p>
	<p>		<p>
	~~If a positive error code is returned, the~~ next 10 bytes contain the ~~userid followed by 2~~ bytes containing the binary user number. 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 user ID, then follows two bytes containing the binary user number. 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 31:		Line 31:

	===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)
	-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 - User not logged on any more		-15 User not logged on any more
	</p>		</p>

JAL: link repair

2016-09-13T18:30:33Z

link repair

← Older revision		Revision as of 18:30, 13 September 2016
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve user's statistics into string</span>		<span class="pageSubtitle">Retrieve user's statistics into string</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStat function is the [[UserStatistics class]].</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStat function is the [[UserStatistics class]].</p>

	This function allows retrieval of a specific user's statistics into a string.		This function allows retrieval of a specific user's statistics into a string.
Line 24:		Line 24:
	<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.		<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>		<p>
	For more information about available statistics, see the <var class="~~book~~">[~~http://sirius-software.com/maint/download/monr.pdf~~ SirMon ~~User's Guide~~]</var>. </p></td></tr>		For more information about available statistics, see the <var class="product">[[SirMon#SirMon topics\|SirMon]]</var> wiki pages. </p></td></tr>

	<tr><th>user_num</th>		<tr><th>user_num</th>

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

2014-08-13T20:36:50Z

Products authorizing {{PAGENAMEE}}

← Older revision		Revision as of 20:36, 13 August 2014
Line 62:		Line 62:
	==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\|$UsStat]]		[[Category:$Functions\|$UsStat]]

JAL at 00:34, 25 July 2013

2013-07-25T00:34:48Z

← Older revision		Revision as of 00:34, 25 July 2013
Line 6:		Line 6:
	This function allows retrieval of a specific user's statistics into a string.		This function allows retrieval of a specific user's statistics into a string.

	The $UsStat function accepts two argument and returns a string made up of an error code and returned statistics.		The <var>$UsStat</var> function accepts two 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 $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 user number of the user for which data is to be returned~~.

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

			===Syntax terms===
			<table>
			<tr><th>%string</th>
			<td>A string containing binary data, the first 4 bytes of which is an [[#Return codes\|error code]].
	<p>		<p>
	<var class="term">%string</var> is ~~made~~ up of binary data, the ~~first 4 bytes of which is an [[#Return codes\|error code]]~~. </p>		If the error code is negative, <var class="term">%string</var> will only be 4 bytes long. If the error 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. </p>
			<p>
			If a positive error code is returned, the next 10 bytes contain the userid followed by 2 bytes containing the binary user number. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></td></tr>

	If the ~~error code~~ is ~~negative~~, <var class="~~term~~">~~%string~~</var> ~~will only be 4 bytes long. If the error 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~~.		<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="book">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>. </p></td></tr>

	~~If a positive error code is returned, the next 10 bytes contain the userid followed by 2 bytes containing the binary~~ user number~~. This means that~~ the ~~actual~~ data ~~starts at offset 16 (byte number 17) in the result string~~.		<tr><th>user_num</th>
			<td>The user number of the user 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)
	-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 - User not logged on any more		-15 - User not logged on any more
	</p>		</p>

	==Example==		==Example==
	The following program displays some totals for user 0.		The following program displays some totals for user 0.
	<p class="code"> B		<p class="code">B

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

	%DATA = $UsStat('CPU SVIO PNAME DKIO', 0)		%DATA = $UsStat('CPU SVIO PNAME DKIO', 0)
	IF $LEN(%DATA) = 4 THEN		IF $LEN(%DATA) = 4 THEN
	PRINT '$USSTAT ERROR... RC = ' WITH -		PRINT '$USSTAT ERROR... RC = ' WITH -
	$UNBIN(%DATA)		$UNBIN(%DATA)
	STOP		STOP
	END IF		END IF

	PRINT 'USERID = ' WITH $SUBSTR(%DATA, 5, 10)		PRINT 'USERID = ' WITH $SUBSTR(%DATA, 5, 10)
	PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) )		PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) )
	PRINT 'SVIO = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) )		PRINT 'SVIO = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) )
	PRINT 'PNAME = ' WITH SUBSTR(%DATA, 25, 16) )		PRINT 'PNAME = ' WITH SUBSTR(%DATA, 25, 16) )
	PRINT 'DKIO = ' WITH $UNBIN( $SUBSTR(%DATA, 41, 4) )		PRINT 'DKIO = ' WITH $UNBIN( $SUBSTR(%DATA, 41, 4) )

	END		END
	</p>		</p>

Line 56:		Line 64:
	<li>[[Sirius $Functions]]		<li>[[Sirius $Functions]]
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

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

JALWiccan: Automatically generated page update

2013-07-19T18:59:42Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve user's statistics into string</span>		<span class="pageSubtitle">Retrieve user's statistics into string</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStat function is the [[UserStatistics class]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStat function is the [[UserStatistics class]].</p>

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