LoginToString (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| 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 | 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>[[ | <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. | <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> | ||
==Examples== | ==Examples== | ||
The following example of non-zero <var>Login</var> statistics is produced by a | |||
< | <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=' | <p class="output">time='20080902160613043' userNumber=20 loginTime='20080902094309010' 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 | </p> | ||
</p | |||
==See also== | ==See also== | ||
Latest revision as of 21:42, 20 November 2012
Login statistics in string format (UserStatistics class)
The LoginToString function returns the values of the Login (also called "Final") statistics in the method UserStatistics object. By default, LoginToString will only include those Login statistics with non-zero values; but, as an option, it may include all (including zero) Login statistics.
Syntax
%string = userStatistics:LoginToString[( [Zeros= boolean], - [NamesToLower= boolean])]
Syntax terms
| %string | A longstring variable to contain the listing of the values of the Login statistics. |
|---|---|
| userStatistics | A UserStatistics object variable. |
| Zeros | This name required argument 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 False, which results in the inclusion of only statistics with non-zero values. |
| NamesToLower | This NameRequired argument is a Boolean value that indicates whether the returned Model 204 statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to False. |
Examples
The following example of non-zero Login statistics is produced by a
print %ustat:loginToString(namesToLower=true)
statement. The output line wrapping is altered for display purposes.
time='20080902160613043' userNumber=20 loginTime='20080902094309010' 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
See also
- RequestToString returns the values of the Request statistics in the UserStatistics object.
- ToString returns the values of all the statistics in the object.