LoginToString (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (→Examples) |
m (match syntax table to syntax template, tags and edits) |
||
| 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). | |||
or it | |||
==Syntax== | ==Syntax== | ||
{{Template:UserStatistics:LoginToString syntax}} | {{Template:UserStatistics:LoginToString syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><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> | <tr><th>userStatistics</th> | ||
<td>A UserStatistics object variable. </td></tr> | <td>A <var>UserStatistics</var> object variable. </td></tr> | ||
<tr><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> | |||
<tr><th>NamesToLower</th><td>This <var> | <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> | ||
==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> | ||
< | statement. The output line wrapping is altered for display purposes. | ||
<p class="output">time='20080902160613043' userNumber=20 loginTime='2008090- | |||
The output line wrapping is altered for display purposes. | |||
<p class=" | |||
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 | ||
</ | </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}} | ||
Revision as of 09:21, 31 March 2011
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. LoginToString prints all Login statistics with non-zero values (by default); or it may, optionally, print them all (including zero values).
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 (Zeros) 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 Name-Required 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='2008090- 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- jswap=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.