$SsStatL - Revision history

JAL: link repair

2017-11-27T22:11:59Z

link repair

← Older revision		Revision as of 22:11, 27 November 2017
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve statistics for set of subsystems into $list</span>		<span class="pageSubtitle">Retrieve statistics for set of subsystems into $list</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 $SsStatL 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 $SsStatL function.</p>

	This function allows retrieval of statistics for a set of subsystems into a $list.		This function allows retrieval of statistics for a set of subsystems into a $list.
Line 31:		Line 31:

	<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>[[$StatLD]]</var> 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>~~. </td></tr>		<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>[[$StatLD]]</var> with the returned $list. For more information about available statistics, see [[Subsystem statistics displayed in SirMon]]. </td></tr>

	<tr><th>criterion</th>		<tr><th>criterion</th>
Line 38:		Line 38:
	<table>		<table>
	<tr><th><var>FILE=</var>filename</th>		<tr><th><var>FILE=</var>filename</th>
	<td>~~include~~ only subsystems that have opened file ''filename''.</td></tr>		<td>Include only subsystems that have opened file <var class="term">filename</var>.</td></tr>

	<tr><th><var>SUBSYS=</var>subsysid</th>		<tr><th><var>SUBSYS=</var>subsysid</th>
	<td>~~include~~ only subsystems with names matching ''subsysid'' (wildcards allowed).</td></tr>		<td>Include only subsystems with names matching <var class="term">subsysid</var> (wildcards allowed).</td></tr>
	</table>		</table>
	<p>		<p>

JAL: /* Return codes */

2014-10-10T22:57:33Z

Return codes

← Older revision		Revision as of 22:57, 10 October 2014
Line 48:		Line 48:

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

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 87:		Line 87:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius functions]]		<li>[[List of $functions\|Sirius functions]]
	</ul>		</ul>

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

JAL: /* Syntax terms */

2013-07-24T20:11:06Z

Syntax terms

← Older revision		Revision as of 20:11, 24 July 2013
Line 31:		Line 31:

	<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. For more information about available statistics, see the <var class="product">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>. </td></tr>		<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>[[$StatLD]]</var> 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>. </td></tr>

	<tr><th>criterion</th>		<tr><th>criterion</th>

JAL: /* Return codes */

2013-07-24T20:05:51Z

Return codes

← Older revision		Revision as of 20:05, 24 July 2013
Line 48:		Line 48:

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

JAL: /* Syntax terms */

2013-07-24T20:04:01Z

Syntax terms

← Older revision		Revision as of 20:04, 24 July 2013
Line 19:		Line 19:
	<tr><th>list_identifier</th>		<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:		<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="~~syntaxTable~~">		<table class="thJustBold">
	<tr><th>Byte 1-10</th>		<tr><th>Byte 1-10</th>
	<td>Blank padded subsystem name</td></tr>		<td>Blank padded subsystem name</td></tr>
Line 37:		Line 37:

	<table>		<table>
	<tr><th>FILE=filename</th>		<tr><th><var>FILE=</var>filename</th>
	<td>include only subsystems that have opened file '''filename'''.</td></tr>		<td>include only subsystems that have opened file ''filename''.</td></tr>

	<tr><th>SUBSYS=subsysid</th>		<tr><th><var>SUBSYS=</var>subsysid</th>
	<td>include only subsystems with names matching '''subsysid''' (wildcards allowed).</td></tr>		<td>include only subsystems with names matching ''subsysid'' (wildcards allowed).</td></tr>
	</table>		</table>
	<p>		<p>

JAL at 22:24, 23 July 2013

2013-07-23T22:24:13Z

← Older revision		Revision as of 22:24, 23 July 2013
Line 8:		Line 8:
	The <var>$SsStatL</var> function accepts three arguments and returns a numeric error code.		The <var>$SsStatL</var> function accepts three arguments 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">$SsStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)
			</p>

			===Syntax terms===
			<table>
			<tr><th>%result</th>
			<td>Either a positive number (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="syntaxTable">		<table class="syntaxTable">
	<tr><th>Byte 1-10</th>		<tr><th>Byte 1-10</th>
Line 18:		Line 28:
	<tr><th>Byte 13-</th>		<tr><th>Byte 13-</th>
	<td>Returned statistics</td></tr>		<td>Returned statistics</td></tr>
	</table>		</table></td></tr>

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

	~~The third argument is a~~ selection criterion that indicates which files are to be included in the output $list. The following criteria are allowed:		<tr><th>criterion</th>
			<td>A selection criterion that indicates which files are to be included in the output $list. The following criteria are allowed:

	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>FILE=filename</th>		<tr><th>FILE=filename</th>
	<td>include only subsystems that have opened file '''filename'''.</td></tr>		<td>include only subsystems that have opened file '''filename'''.</td></tr>
Line 31:		Line 43:
	<td>include only subsystems with names matching '''subsysid''' (wildcards allowed).</td></tr>		<td>include only subsystems with names matching '''subsysid''' (wildcards allowed).</td></tr>
	</table>		</table>

	In actual fact, all files are always included in the output list, but the excluded subsystems have the high order bit of byte 11 turned on. This tells <var>$StatLD</var> to exclude the subsystems from the difference $list.

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

	<p>		<p>
	<var ~~class="term"~~>~~%result~~</var> ~~is either a positive number (milliseconds since~~ the ~~online was brought up) or a negative error code~~.</p>		In actual fact, all files are always included in the output list, but the excluded subsystems have the high order bit of byte 11 turned on. This tells <var>$StatLD</var> to exclude the subsystems from the difference $list. </p></td></tr>
			</table>

	===Return codes===		===Return codes===

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 statistics for set of subsystems into $list</span>		<span class="pageSubtitle">Retrieve statistics for set of subsystems into $list</span>

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

	This function allows retrieval of statistics for a set of subsystems into a $list.		This function allows retrieval of statistics for a set of subsystems into a $list.

JALWiccan: Automatically generated page update

2013-04-12T18:43:42Z

Automatically generated page update

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

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$SsStatL</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">$SsStatL</span>(<span class="term">list_identifier</span>, <span class="term">stat_list</span>, <span class="term">criterion</span>)
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-12T18:31:01Z

Automatically generated page update

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

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$SsStatL</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">$SsStatL</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>		</p>