LoginToString (UserStatistics function) - Revision history

JAL at 21:42, 20 November 2012

2012-11-20T21:42:14Z

← Older revision		Revision as of 21:42, 20 November 2012
Line 1:		Line 1:
	{{Template:UserStatistics:LoginToString subtitle}}		{{Template:UserStatistics:LoginToString subtitle}}
	The <var>LoginToString</var> function returns the values of the [[UserStatistics class#login\|Login]] (also called "Final") statistics in the method <var>UserStatistics</var> object. By default, <var>LoginToString</var> will only include those ~~<var>~~Login~~</var>~~ statistics with non-zero values; but, ~~optionally~~, may include all (including zero) ~~<var>~~Login~~</var>~~ statistics.		The <var>LoginToString</var> function returns the values of the [[UserStatistics class#login\|Login]] (also called "Final") statistics in the method <var>UserStatistics</var> object. By default, <var>LoginToString</var> will only include those Login statistics with non-zero values; but, as an option, it may include all (including zero) Login statistics.

	==Syntax==		==Syntax==
	{{Template:UserStatistics:LoginToString syntax}}		{{Template:UserStatistics:LoginToString syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A <var>longstring</var> variable to contain the listing of the values of the <var>Login</var> statistics. </td></tr>		<td>A <var>longstring</var> variable to contain the listing of the values of the <var>Login</var> statistics. </td></tr>

	<tr><th>userStatistics</th>		<tr><th>userStatistics</th>
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>

	<tr><th><var>Zeros</var></th>		<tr><th><var>Zeros</var></th>
	<td>This <var>[[~~Methods~~#Named parameters\|~~NameRequired~~]]</var> argument ~~(<var>Zeros</var>)~~ is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>		<td>This <var>[[Notation conventions for methods#Named parameters\|name required]] </var> argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>

	<tr><th><var>NamesToLower</var></th>		<tr><th><var>NamesToLower</var></th>
	<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>		<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
	</table>		</table>

Line 20:		Line 24:
	<code>print %ustat:loginToString(namesToLower=true)</code>		<code>print %ustat:loginToString(namesToLower=true)</code>
	statement. The output line wrapping is altered for display purposes.		statement. The output line wrapping is altered for display purposes.
	<p class="output">time='20080902160613043' userNumber=20 loginTime='~~2008090-~~		<p class="output">time='20080902160613043' userNumber=20 loginTime='20080902094309010' cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 req=1 -
	~~2094309010~~' cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 req=1 -		move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 objswap=250247
	move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 ~~ob-~~
	~~jswap~~=250247
	</p>		</p>

JALWiccan: 1 revision

2011-05-24T20:32:19Z

1 revision

← Older revision	Revision as of 20:32, 24 May 2011
(No difference)

JAL2: /* Examples */

2011-05-24T20:32:18Z

Examples

← Older revision		Revision as of 20:32, 24 May 2011
Line 11:		Line 11:
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th><var>Zeros</var></th>		<tr><th><var>Zeros</var></th>
	<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
	<tr><th><var>NamesToLower</var></th>		<tr><th><var>NamesToLower</var></th>
	<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>		<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>

JAL2: /* Examples */

2011-05-03T00:58:38Z

Examples

← Older revision		Revision as of 00:58, 3 May 2011
Line 17:		Line 17:

	==Examples==		==Examples==
	~~<ol><li>~~The following example of non-zero <var>Login</var> statistics is produced by a		The following example of non-zero <var>Login</var> statistics is produced by a
	<~~p class="~~code">print %ustat:loginToString(namesToLower=true)</p>		<code>print %ustat:loginToString(namesToLower=true)</code>
	statement. The output line wrapping is altered for display purposes.		statement. The output line wrapping is altered for display purposes.
	<p class="output">time='20080902160613043' userNumber=20 loginTime='2008090-		<p class="output">time='20080902160613043' userNumber=20 loginTime='2008090-
Line 24:		Line 24:
	move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 ob-		move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 ob-
	jswap=250247		jswap=250247
	</p~~></ol~~>		</p>

	==See also==		==See also==

JAL2: /* Syntax terms */

2011-05-03T00:24:01Z

Syntax terms

← Older revision		Revision as of 00:24, 3 May 2011
Line 10:		Line 10:
	<tr><th>userStatistics</th>		<tr><th>userStatistics</th>
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th>Zeros</th>		<tr><th><var>Zeros</var></th>
	<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var ~~class="term"~~>Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var ~~class="term"~~>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
	<tr><th>NamesToLower</th><td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>		<tr><th><var>NamesToLower</var></th>
			<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
	</table>		</table>

Dme: Undo revision 28673 by JAL2 (talk)

2011-04-13T13:43:27Z

Undo revision 28673 by JAL2 (talk)

← Older revision		Revision as of 13:43, 13 April 2011
Line 12:		Line 12:
	<tr><th>Zeros</th>		<tr><th>Zeros</th>
	<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
	<tr><th>NamesToLower</th>		<tr><th>NamesToLower</th><td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
	<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
	</table>		</table>

JAL2: /* Syntax terms */

2011-04-13T02:35:50Z

Syntax terms

← Older revision		Revision as of 02:35, 13 April 2011
Line 12:		Line 12:
	<tr><th>Zeros</th>		<tr><th>Zeros</th>
	<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
	<tr><th>NamesToLower</th><td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>		<tr><th>NamesToLower</th>
			<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
	</table>		</table>

JAL2: /* Syntax terms */

2011-04-13T02:34:11Z

Syntax terms

← Older revision		Revision as of 02:34, 13 April 2011
Line 11:		Line 11:
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th>Zeros</th>		<tr><th>Zeros</th>
	<td>This <var>[[Methods#Named parameters\|~~Name-Required~~]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
	<tr><th>NamesToLower</th><td>This <var>~~Name-Required~~</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>		<tr><th>NamesToLower</th><td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
	</table>		</table>

Goff: that's a better way to say it

2011-03-31T10:11:17Z

that's a better way to say it

← Older revision		Revision as of 10:11, 31 March 2011
Line 1:		Line 1:
	{{Template:UserStatistics:LoginToString subtitle}}		{{Template:UserStatistics:LoginToString subtitle}}
	The <var>LoginToString</var> function returns the values of the [[UserStatistics class#login\|Login]] (also called "Final") statistics in the method <var>UserStatistics</var> object. <var>LoginToString</var> ~~prints all~~ <var>Login</var> statistics with non-zero values ~~(by default)~~; ~~or it may~~, optionally, ~~print them~~ all (including zero ~~values~~).		The <var>LoginToString</var> function returns the values of the [[UserStatistics class#login\|Login]] (also called "Final") statistics in the method <var>UserStatistics</var> object. By default, <var>LoginToString</var> will only include those <var>Login</var> statistics with non-zero values; but, optionally, may include all (including zero) <var>Login</var> statistics.

	==Syntax==		==Syntax==

Goff: match syntax table to syntax template, tags and edits

2011-03-31T09:21:05Z

match syntax table to syntax template, tags and edits

← Older revision		Revision as of 09:21, 31 March 2011
Line 1:		Line 1:
	{{Template:UserStatistics:LoginToString subtitle}}		{{Template:UserStatistics:LoginToString subtitle}}
			The <var>LoginToString</var> function returns the values of the [[UserStatistics class#login\|Login]] (also called "Final") statistics in the method <var>UserStatistics</var> object. <var>LoginToString</var> prints all <var>Login</var> statistics with non-zero values (by default); or it may, optionally, print them all (including zero values).
	~~This~~ function returns the values of the [[UserStatistics class#login\|Login]] (also called Final) statistics in the method UserStatistics object.
	~~The method~~ prints all Login statistics with non-zero values (by default),
	or it ~~prints~~ all ~~Login statistics~~ (~~as an option~~).
	==Syntax==		==Syntax==
	{{Template:UserStatistics:LoginToString syntax}}		{{Template:UserStatistics:LoginToString syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th~~><i~~>%~~ls</i>~~</th>		<tr><th>%string</th>
	<td>A longstring variable to contain the listing of the values of the Login statistics. </td></tr>		<td>A <var>longstring</var> variable to contain the listing of the values of the <var>Login</var> statistics. </td></tr>
	<tr><th>~~<i>%ustat</i>~~</th>		<tr><th>userStatistics</th>
	<td>A UserStatistics object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th~~><b~~>Zeros= </b><i>~~bool~~</i></th>		<tr><th>Zeros</th>
	~~<td>This name required~~ argument (<tt>Zeros</tt>) is a ~~boolean~~ value that indicates whether statistics with a zero value should be included in the returned data. Zeros is an optional argument that defaults to <tt>False</tt>, which results in the inclusion of only statistics with non-zero values.</td></tr>		<td>This <var>[[Methods#Named parameters\|Name-Required]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
	<tr><th>NamesToLower</th><td>This <var>~~[[Methods#Named parameters\|~~Name-Required]]</var> argument is a <var>[[Boolean]]</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>		<tr><th>NamesToLower</th><td>This <var>Name-Required</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
	</table>		</table>

	~~==Usage notes==~~
	~~<ul>~~
	~~<li>The [[RequestToString (UserStatistics function)\|RequestToString]] function~~
	~~returns the values of the Request statistics~~
	~~in the UserStatistics object.~~
	~~The [[ToString (UserStatistics function)\|ToString]] function~~
	~~returns the values of all the statistics in the object.~~
	~~</ul>~~
	==Examples==		==Examples==
			<ol><li>The following example of non-zero <var>Login</var> statistics is produced by a
	The following example of non-zero Login statistics is produced by a		<p class="code">print %ustat:loginToString(namesToLower=true)</p>
	<~~br>~~		statement. The output line wrapping is altered for display purposes.
	<code>~~Print~~ %ustat:loginToString(namesToLower=true)</~~code~~> statement.		<p class="output">time='20080902160613043' userNumber=20 loginTime='2008090-
	The output line wrapping is altered for display purposes.
	<p class="~~code~~"~~><nowiki~~>time='20080902160613043' userNumber=20 loginTime='2008090-
	2094309010' cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 req=1 -		2094309010' cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 req=1 -
	move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 ob-		move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 ob-
	jswap=250247		jswap=250247
	</~~nowiki~~></p>		</p></ol>

	==See also==		==See also==
			<ul>
			<li><var>[[RequestToString (UserStatistics function)\|RequestToString]]</var> returns the values of the <var>Request</var> statistics in the <var>UserStatistics</var> object.
			<li><var>[[ToString (UserStatistics function)\|ToString]]</var> returns the values of all the statistics in the object.
			</ul>
	{{Template:UserStatistics:LoginToString footer}}		{{Template:UserStatistics:LoginToString footer}}