$TkStatL - Revision history

JAL: link repair

2017-11-27T22:15:58Z

link repair

← Older revision		Revision as of 22:15, 27 November 2017
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve statistics for all tasks into $list</span>		<span class="pageSubtitle">Retrieve statistics for all tasks into $list</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 $TkStatL function.</p>		<p class="warn"><b>Note:</b> Many $functions are deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TkStatL function.</p>

	This function allows retrieval of statistics for all tasks into a $list.		This function allows retrieval of statistics for all tasks into a $list.
Line 33:		Line 33:

	<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 [[$StatLD]] with the returned $list.		<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 [[$StatLD]] with the returned $list.
	<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 [[Task statistics displayed in SirMon]]. </p></td></tr>
	</table>		</table>

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

2014-08-13T20:38:31Z

Products authorizing {{PAGENAMEE}}

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

JAL at 23:03, 24 July 2013

2013-07-24T23:03:11Z

← Older revision		Revision as of 23:03, 24 July 2013
Line 8:		Line 8:
	The $TkStatL function accepts two argument and returns a numeric error code.		The $TkStatL function accepts two argument and returns a numeric error code.

	~~The first argument is the identifier of the~~ $~~list that is to receive the results. The current contents of the $list are deleted and replaced with the requested statistics. The format of each $list item is:~~		==Syntax==
			<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)
			</p>

	<table class="~~syntaxTable~~">		===Syntax terms===
			<table>
			<tr><th>%result</th>
			<td>Either a positive number, which is the milliseconds since the online was brought up, or a negative error code.</td></tr>

			<tr><th>list_identifier</th>
			<td>The identifier of the $list that is to receive the results. The current contents of the $list are deleted and replaced with the requested statistics. The format of each $list item is:

			<table class="thJustBold">
	<tr><th>Byte 1-10</th>		<tr><th>Byte 1-10</th>
	<td>Blanks</td></tr>		<td>Blanks</td></tr>

	<tr><th>Byte 11-12</th>		<tr><th>Byte 11-12</th>
	<td>Binary task number</td></tr>		<td>Binary task number</td></tr>

	<tr><th>Byte 13-</th>		<tr><th>Byte 13-</th>
	<td>Returned statistics		<td>Returned statistics</td></tr>
			</table>
	</td></tr>		</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 [[$StatLD]] with the returned $list.
			<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>
	</table>		</table>

	The second 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 [[$StatLD]] with the returned $list. 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">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)

	~~<var class="term">%result</var> is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>~~

	===Return codes===		===Return codes===
	<p class="code"> -3 - No room to create $list items		<p class="code"> -3 - No room to create $list items (if LISTFC <var>$SirParm</var> parameter not set)
	(if LISTFC <var>$SirParm</var> parameter not set)
	-5 - Required parameter not specified		-5 - Required parameter not specified
	-6 - Invalid $list identifier		-6 - Invalid $list identifier
Line 66:		Line 76:
	<li>[[Sirius $Functions]]		<li>[[Sirius $Functions]]
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

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

JALWiccan: Automatically generated page update

2013-07-19T18:59:37Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve statistics for all tasks into $list</span>		<span class="pageSubtitle">Retrieve statistics for all tasks into $list</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TkStatL function.</p>		<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 $TkStatL function.</p>

	This function allows retrieval of statistics for all tasks into a $list.		This function allows retrieval of statistics for all tasks into a $list.

JALWiccan: Automatically generated page update

2013-04-12T18:43:44Z

Automatically generated page update

← Older revision		Revision as of 18:43, 12 April 2013
Line 23:		Line 23:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier</span>, ~~<span class="term"></span>~~<span class="term">stat_list</span>, ~~<span class="term"></span>~~<span class="term">criterion</span>)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)

	<var class="term">%result</var> is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>		<var class="term">%result</var> is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>

JALWiccan: Automatically generated page update

2013-04-12T18:31:04Z

Automatically generated page update

← Older revision		Revision as of 18:31, 12 April 2013
Line 23:		Line 23:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier</span>, <span class="term"></span><span class="term">stat_list</span>, <span class="term"></span><span class="term">criterion</span>)

	<var class="term">%result</var> is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>		<var class="term">%result</var> is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>

JAL: /* Syntax */

2013-04-11T22:04:12Z

Syntax

← Older revision		Revision as of 22:04, 11 April 2013
Line 23:		Line 23:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier, stat_list, criterion)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)

			<var class="term">%result</var> is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>

			===Return codes===
			<p class="code"> -3 - No room to create $list items
			(if LISTFC <var>$SirParm</var> parameter not set)
			-5 - Required parameter not specified
			-6 - Invalid $list identifier
			-13 - STAT not linked in
	</p>		</p>
	~~<p>%result is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>~~

	~~<p class~~=~~"code">~~		==Example==
	~~-3 - No room to create $list items~~
	~~(if LISTFC <var>$SirParm</var> parameter not set)~~
	~~-5 - Required parameter not specified~~
	~~-6 - Invalid $list identifier~~
	~~-13 - STAT not linked in~~
	~~</p>~~
	~~<p class~~=~~"caption">$TkStatL return codes~~
	~~</p>~~
	The following program displays some statistics for all tasks:		The following program displays some statistics for all tasks:

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

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

	%LIST = $ListNew		%LIST = $ListNew

	%DATA = $TkStatL(%LIST, 'CPU STDEQ LKWAIT')		%DATA = $TkStatL(%LIST, 'CPU STDEQ LKWAIT')
	IF %DATA < 0 THEN		IF %DATA < 0 THEN
	PRINT '$TKSTATL ERROR... RC = ' WITH %DATA		PRINT '$TKSTATL ERROR... RC = ' WITH %DATA
	STOP		STOP
	END IF		END IF

	FOR %I FROM 1 TO $ListCnt(%LIST)		FOR %I FROM 1 TO $ListCnt(%LIST)
	%DATA = $ListInf(%LIST, %I)		%DATA = $ListInf(%LIST, %I)
	PRINT 'TASKNUM = ' WITH $UNBIN( $SUBSTR(%DATA, 11, 2) )		PRINT 'TASKNUM = ' WITH $UNBIN( $SUBSTR(%DATA, 11, 2) )
	PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 13, 4) )		PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 13, 4) )
	PRINT 'STDEQ = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) )		PRINT 'STDEQ = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) )
	PRINT 'LKWAIT = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) )		PRINT 'LKWAIT = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) )
	PRINT		PRINT
	END FOR		END FOR

	END		END
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-10T21:52:44Z

Automatically generated page update

← Older revision		Revision as of 21:52, 10 April 2013
Line 23:		Line 23:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = $TkStatL(list_identifier, stat_list, criterion)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$TkStatL</span>(<span class="term">list_identifier, stat_list, criterion)
	</p>		</p>
	<p>%result is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>		<p>%result is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>

JALWiccan: Automatically generated page update

2013-04-10T21:29:09Z

Automatically generated page update

← Older revision		Revision as of 21:29, 10 April 2013
Line 23:		Line 23:

	==Syntax==		==Syntax==
	<p class="syntax">%result = $TkStatL(list_identifier, stat_list, criterion)		<p class="syntax"><span class="term">%result</span> = $TkStatL(list_identifier, stat_list, criterion)
	</p>		</p>
	<p>%result is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>		<p>%result is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>

JALWiccan: Automatically generated page update

2013-04-10T18:17:54Z

Automatically generated page update

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

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>%result = $TkStatL(list_identifier, stat_list, criterion)		<p class="syntax">%result = $TkStatL(list_identifier, stat_list, criterion)
	~~<section end="syntax" />~~</p>		</p>
	<p>%result is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>		<p>%result is a either a positive number, which is the milliseconds since the online was brought up, or is a negative error code.</p>