$TkStat - Revision history

JAL: /* Syntax */ add "unsigned"

2016-10-04T14:55:03Z

Syntax: add "unsigned"

← Older revision		Revision as of 14:55, 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 blanks, then follows 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 blanks, then follows 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-03T21:53:00Z

clarify return value

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

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

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

	==Syntax==		==Syntax==
Line 15:		Line 13:
	<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 blanks, then follows 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 blanks, then follows 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-03T21:11:14Z

clarify return value

← Older revision		Revision as of 21:11, 3 October 2016
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve task's statistics into string</span>		<span class="pageSubtitle">Retrieve task'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 no OO equivalent for the $TkStat 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>$TkStat</var> function.</p>

	This function allows retrieval of a specific task's statistics into a string.		This function allows retrieval of a specific task's statistics into a string.
Line 15:		Line 15:
	<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 %~~string ~~will only be 4 bytes long~~.</td></tr>		<td>A string containing binary data. If the string is exactly four bytes, it contains 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. </p>
			<p>
			The next ten bytes contain blanks, then follows 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. 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 four 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="book">[[SirMon]]</var> M204wiki pages.</p> </td></tr>

	<tr><th>task_num</th>		<tr><th>task_num</th>
	<td>The task number of the task for which data is to be returned. The maintask is always task number 0. Other tasks are only available for Onlines running the MP/204 feature.</td></tr>		<td>The task number of the task for which data is to be returned. The maintask is always task number 0. Other tasks are only available for Onlines running the [[MP/204]] feature.</td></tr>
	</table>		</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 > NMPSUBS)		-12 Invalid parameter (argument 2 > NMPSUBS)
	-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==~~
	~~<ul>~~
	<li>The data returned by $TkStat 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 a 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 blanks followed by 2 bytes of binary 0. 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 subtask 1:		The following program displays some totals for subtask 1:

	<p class="code">B		<p class="code">Begin
			%data IS STRING LEN 255

	%~~DATA IS STRING LEN 255~~		%data = $TkStat('CPU STDEQ LKWAIT', 1)
			IF $LEN(%data) = 4 THEN
	~~%DATA~~ = $TkStat('CPU STDEQ LKWAIT', 1)		PRINT '$TKSTAT ERROR... RC = ' WITH $Unbin(%data)
	IF $LEN(%~~DATA~~) = 4 THEN
	PRINT '$TKSTAT ERROR... RC = ' WITH $~~UNBIN~~(%~~DATA~~)
	STOP		STOP
	END IF		END IF

	PRINT 'CPU = ' WITH $~~UNBIN~~( $~~SUBSTR~~(%~~DATA~~, 17, 4) )		PRINT 'CPU = ' WITH $Unbin( $Substr(%data, 17, 4) )
	PRINT 'STDEQ = ' WITH $~~UNBIN~~( $~~SUBSTR~~(%~~DATA~~, 21, 4) )		PRINT 'STDEQ = ' WITH $Unbin( $Substr(%data, 21, 4) )
	PRINT 'LKWAIT = ' WITH $~~UNBIN~~( $~~SUBSTR~~(%~~DATA~~, 25, 4) )		PRINT 'LKWAIT = ' WITH $Unbin( $Substr(%data, 25, 4) )
			End
	~~END~~
	</p>		</p>

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

2014-08-13T20:37:53Z

Products authorizing {{PAGENAMEE}}

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

JAL at 22:47, 24 July 2013

2013-07-24T22:47:24Z

← Older revision		Revision as of 22:47, 24 July 2013
Line 6:		Line 6:
	This function allows retrieval of a specific task's statistics into a string.		This function allows retrieval of a specific task's statistics into a string.

	The $TkStat function accepts two argument and returns a string made up of an error code and returned statistics.		The <var>$TkStat</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~~>.		==Syntax==
			<p class="syntax"><span class="term">%string</span> = <span class="literal">$TkStat</span>(<span class="term">stat_list</span>, <span class="term">task_num</span>)
			</p>

	~~The second argument is~~ the ~~task number~~ of ~~the task for~~ which ~~data~~ is ~~to be returned~~. ~~The maintask~~ is ~~always task number 0~~. ~~Other tasks are only available for onlines running the MP~~/~~204 feature.~~		===Syntax terms===
			<table>
			<tr><th>%string</th>
			<td>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.</td></tr>

	~~==Syntax==~~		<tr><th>stat_list</th>
	<~~p class="syntax"~~><~~span class="term"~~>~~%STRING~~</~~span~~> = <~~span class="literal"~~>$~~TkStat~~</~~span~~>(<~~span class="term">stat_list</span~~>, <~~span~~ class="~~term~~">~~task_num~~</~~span~~>)		<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>
	<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>		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>

	The data ~~returned by $TkStat 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 a~~ 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 blanks followed by 2 bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.		<tr><th>task_num</th>
			<td>The task number of the task for which data is to be returned. The maintask is always task number 0. Other tasks are only available for Onlines running the MP/204 feature.</td></tr>
			</table>

	<p class="code">		===Return codes===
	-5 - Required parameter not specified		<p class="code"> -5 - Required parameter not specified
	-12 - Invalid parameter (argument 2 > NMPSUBS)		-12 - Invalid parameter (argument 2 > NMPSUBS)
	-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 class="caption">$TkStat return codes~~
	</p>		</p>

	The following program displays some totals for subtask 1.		==Usage notes==
			<ul>
			<li>The data returned by $TkStat 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 a 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 blanks followed by 2 bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.
			</ul>

			==Example==
			The following program displays some totals for subtask 1:

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

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

	%DATA = $TkStat('CPU STDEQ LKWAIT', 1)		%DATA = $TkStat('CPU STDEQ LKWAIT', 1)
	IF $LEN(%DATA) = 4 THEN		IF $LEN(%DATA) = 4 THEN
	PRINT '$TKSTAT ERROR... RC = ' WITH $UNBIN(%DATA)		PRINT '$TKSTAT ERROR... RC = ' WITH $UNBIN(%DATA)
	STOP		STOP
	END IF		END IF

	PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) )		PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) )
	PRINT 'STDEQ = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) )		PRINT 'STDEQ = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) )
	PRINT 'LKWAIT = ' WITH $UNBIN( $SUBSTR(%DATA, 25, 4) )		PRINT 'LKWAIT = ' WITH $UNBIN( $SUBSTR(%DATA, 25, 4) )

	END		END
	</p>		</p>

Line 51:		Line 62:
	<li>[[Sirius $Functions]]		<li>[[Sirius $Functions]]
	</ul>		</ul>

	~~<p>~~
	~~</p>~~

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

JALWiccan: Automatically generated page update

2013-07-19T18:59:36Z