$UsStatL - Revision history

DCameron: /* Error codes */

2018-02-28T11:14:09Z

Error codes

← Older revision		Revision as of 11:14, 28 February 2018
Line 74:		Line 74:
	-5 — Required parameter not specified.		-5 — Required parameter not specified.
	-6 — Invalid $list identifier.		-6 — Invalid $list identifier.
			-12 — invalid stat name.
	-13 — STAT not linked in.		-13 — STAT not linked in.
	-16 — Invalid selection criterion.		-16 — Invalid selection criterion.

JAL: link repair

2016-07-26T18:05:01Z

link repair

← Older revision		Revision as of 18:05, 26 July 2016
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve statistics for set of users into $list</span>		<span class="pageSubtitle">Retrieve statistics for set of users into $list</span>

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

	==Syntax==		==Syntax==
Line 29:		Line 29:

	<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="book">~~[~~http://m204wiki.rocketsoftware.com/images/5/5e/MonrNew.pdf Rocket M204~~ 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 [[User statistics displayed in SirMon]]. </td></tr>

	<tr><th>criterion</th>		<tr><th>criterion</th>
Line 104:		Line 104:
	End		End
	</p>		</p>

	~~==Products authorizing {{PAGENAMEE}}==~~
	~~<ul class="smallAndTightList">~~
	~~<li>[[List of $functions\|Sirius functions]] </li>~~
	~~</ul>~~

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

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

2014-08-13T20:34:10Z

Products authorizing {{PAGENAMEE}}

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

JAL at 16:21, 18 March 2014

2014-03-18T16:21:16Z

← Older revision		Revision as of 16:21, 18 March 2014
Line 3:		Line 3:

	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $UsStatL 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 $UsStatL function is the [[UserStatistics class]].</p>

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

	~~The <var>$UsStatL</var> function accepts three arguments and returns a numeric error code.~~

	==Syntax==		==Syntax==
Line 15:		Line 11:
	<table>		<table>
	<tr><th>%result</th>		<tr><th>%result</th>
	<td>Either a positive number, which is the milliseconds since the ~~online~~ was brought up, or a negative [[#Error codes\|error code]].</td></tr>		<td>Either a positive number, which is the milliseconds since the Online was brought up, or a negative [[#Error codes\|error code]].</td></tr>

	<tr><th>list_identifier</th>		<tr><th>list_identifier</th>
Line 33:		Line 29:

	<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 $StatLD with the returned $list. For more information about available statistics, see the <var class="book">[http://m204wiki.rocketsoftware.com/images/5/5e/MonrNew.pdf Rocket M204 SirMon User's Guide]</var>. </td></tr>

	<tr><th>criterion</th>		<tr><th>criterion</th>
Line 40:		Line 36:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th><var>ACCOUNT=</var>acctid</th>		<tr><th><var>ACCOUNT=</var>acctid</th>
	<td>~~include~~ only users with account ~~ids~~ matching <var class="term">acctid</var> (wildcards allowed).</td></tr>		<td>Include only users with account IDs matching <var class="term">acctid</var> (wildcards allowed).</td></tr>

	<tr><th><var>CFR=</var>fid</th>		<tr><th><var>CFR=</var>fid</th>
	<td>~~include~~ only users holding or requesting critical file resources in files with filename matching <var class="term">fid</var> (wildcards allowed).</td></tr>		<td>Include only users holding or requesting critical file resources in files with <var class="term">filename</var> matching <var class="term">fid</var> (wildcards allowed).</td></tr>

	<tr><th><var>CHKP</var></th>		<tr><th><var>CHKP</var></th>
	<td>~~include~~ only users preventing checkpoints</td></tr>		<td>Include only users preventing checkpoints.</td></tr>

	<tr><th><var>FILE=</var>filename</th>		<tr><th><var>FILE=</var>filename</th>
	<td>~~include~~ only users with <var class="term">filename</var> open.</td></tr>		<td>Include only users with <var class="term">filename</var> open.</td></tr>

	<tr><th><var>IODEV=</var>iodevnum</th>		<tr><th><var>IODEV=</var>iodevnum</th>
	<td>~~include~~ only users on IODEV <var class="term">iodevnum</var>.</td></tr>		<td>Include only users on IODEV <var class="term">iodevnum</var>.</td></tr>

	<tr><th><var>PNAME=</var>pname</th>		<tr><th><var>PNAME=</var>pname</th>
	<td>~~include~~ only users running procedures with names matching <var class="term">pname</var> (wildcards allowed).</td></tr>		<td>Include only users running procedures with names matching <var class="term">pname</var> (wildcards allowed).</td></tr>

	<tr><th><var>SUBSYS=</var>subsysid</th>		<tr><th><var>SUBSYS=</var>subsysid</th>
	<td>~~include~~ only users in subsystem <var class="term">subsysid</var> (wildcards allowed).</td></tr>		<td>Include only users in subsystem <var class="term">subsysid</var> (wildcards allowed).</td></tr>

	<tr><th><var>TERMID=</var>termid</th>		<tr><th><var>TERMID=</var>termid</th>
	<td>~~include~~ only users logged on terminals with ids matching <var class="term">termid</var> (wildcards allowed).</td></tr>		<td>Include only users logged on terminals with ids matching <var class="term">termid</var> (wildcards allowed).</td></tr>

	<tr><th><var>USER=</var>userid</th>		<tr><th><var>USER=</var>userid</th>
	<td>~~include~~ only users with userids matching <var class="term">userid</var> (wildcards allowed).</td></tr>		<td>Include only users with userids matching <var class="term">userid</var> (wildcards allowed).</td></tr>

	<tr><th><var>WHAT=</var>activity</th>		<tr><th><var>WHAT=</var>activity</th>
	<td>~~include~~ only users with current activity matching <var class="term">activity</var> (wildcards allowed).		<td>Include only users with current activity matching <var class="term">activity</var> (wildcards allowed).
	</td></tr></table>		</td></tr></table>

Line 74:		Line 70:

	===Error codes===		===Error codes===
	<p class="code"> -1 — ~~The user~~ is not waiting. The wait type of a running user is -1.		<p class="code"> -1 — User is not waiting. (The wait type of a running user is -1.)
	-3 — No room to create $list items (if LISTFC <var>$SirParm</var> parameter not set)		-3 — No room to create $list items (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.
	-13 — STAT not linked in		-13 — STAT not linked in.
	-16 — Invalid selection criterion		-16 — Invalid selection criterion.
	</p>		</p>

JAL: /* Error codes */ added -1

2014-03-18T16:11:37Z

Error codes: added -1

← Older revision		Revision as of 16:11, 18 March 2014
Line 74:		Line 74:

	===Error codes===		===Error codes===
	<p class="code"> -3 — No room to create $list items		<p class="code"> -1 — The user is not waiting. The wait type of a running user is -1.
	(if LISTFC <var>$SirParm</var> parameter not set)		-3 — No room to create $list items (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

2013-07-19T18:59:43Z

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

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

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

JALWiccan: Automatically generated page update

2013-04-12T18:43:47Z

Automatically generated page update

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

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

Automatically generated page update

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

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

JAL at 15:01, 12 April 2013

2013-04-12T15:01:20Z

← Older revision		Revision as of 15:01, 12 April 2013
Line 9:		Line 9:

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

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%result</th>		<tr><th>%result</th>
	<td>Either a positive number, which is the milliseconds since the online was brought up, or a negative [[#Error codes\|error code]].</td></tr>		<td>Either a positive number, which is the milliseconds since the online was brought up, or a negative [[#Error codes\|error code]].</td></tr>
Line 20:		Line 20:
	<td>The identifier of the $list 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 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>
	<tr><th>Byte 1-10</th>		<tr><td>Byte 1-10</td>
	<td>Blank padded userid</td></tr>		<td>Blank padded userid</td></tr>
	<tr><th>Byte 11-12</th>
			<tr><td>Byte 11-12</td>
	<td>Binary user number</td></tr>		<td>Binary user number</td></tr>
	<tr><th>Byte 13-</th>
	<td>Returned statistics		<tr><td>Byte 13-</td>
	</td></tr>		<td>Returned statistics</td></tr>
	</table>		</table>
	</td></tr>		</td></tr>
Line 38:		Line 39:

	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>ACCOUNT=acctid</th>		<tr><th><var>ACCOUNT=</var>acctid</th>
	<td>include only users with account ids matching <var class="term">acctid</var> (wildcards allowed).</td></tr>		<td>include only users with account ids matching <var class="term">acctid</var> (wildcards allowed).</td></tr>
	<tr><th>CFR=fid</th>
			<tr><th><var>CFR=</var>fid</th>
	<td>include only users holding or requesting critical file resources in files with filename matching <var class="term">fid</var> (wildcards allowed).</td></tr>		<td>include only users holding or requesting critical file resources in files with filename matching <var class="term">fid</var> (wildcards allowed).</td></tr>
	<tr><th>CHKP</th>
			<tr><th><var>CHKP</var></th>
	<td>include only users preventing checkpoints</td></tr>		<td>include only users preventing checkpoints</td></tr>
	<tr><th>FILE=filename</th>
			<tr><th><var>FILE=</var>filename</th>
	<td>include only users with <var class="term">filename</var> open.</td></tr>		<td>include only users with <var class="term">filename</var> open.</td></tr>
	<tr><th>IODEV=iodevnum</th>
			<tr><th><var>IODEV=</var>iodevnum</th>
	<td>include only users on IODEV <var class="term">iodevnum</var>.</td></tr>		<td>include only users on IODEV <var class="term">iodevnum</var>.</td></tr>
	<tr><th>PNAME=pname</th>
			<tr><th><var>PNAME=</var>pname</th>
	<td>include only users running procedures with names matching <var class="term">pname</var> (wildcards allowed).</td></tr>		<td>include only users running procedures with names matching <var class="term">pname</var> (wildcards allowed).</td></tr>
	<tr><th>SUBSYS=subsysid</th>
			<tr><th><var>SUBSYS=</var>subsysid</th>
	<td>include only users in subsystem <var class="term">subsysid</var> (wildcards allowed).</td></tr>		<td>include only users in subsystem <var class="term">subsysid</var> (wildcards allowed).</td></tr>
	<tr><th>TERMID=termid</th>
			<tr><th><var>TERMID=</var>termid</th>
	<td>include only users logged on terminals with ids matching <var class="term">termid</var> (wildcards allowed).</td></tr>		<td>include only users logged on terminals with ids matching <var class="term">termid</var> (wildcards allowed).</td></tr>
	<tr><th>USER=userid</th>
			<tr><th><var>USER=</var>userid</th>
	<td>include only users with userids matching <var class="term">userid</var> (wildcards allowed).</td></tr>		<td>include only users with userids matching <var class="term">userid</var> (wildcards allowed).</td></tr>
	<tr><th>WHAT=activity</th>
			<tr><th><var>WHAT=</var>activity</th>
	<td>include only users with current activity matching <var class="term">activity</var> (wildcards allowed).		<td>include only users with current activity matching <var class="term">activity</var> (wildcards allowed).
	</td></tr></table>		</td></tr></table>

	In actual fact, all users are always included in the output list, but the excluded users have the high order bit of their user numbers turned on. This tells [[$StatLD]] to exclude the users from the difference $list.</td></tr>		In actual fact, all users are always included in the output list, but the excluded users have the high order bit of their user numbers turned on. This tells <var>[[$StatLD]]</var> to exclude the users from the difference $list.</td></tr>
	</table>		</table>

Line 73:		Line 83:

	==Example==		==Example==
	The following program displays some statistics for all users in subsystem SIRMON.		The following program displays some statistics for all users in subsystem <code>SIRMON</code>.
	<p class="code">b		<p class="code">b

Line 103:		Line 113:
	<li>[[Sirius $Functions]]		<li>[[Sirius $Functions]]
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

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

JALWiccan: Automatically generated page update

2013-04-10T21:52:47Z

Automatically generated page update

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

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