LoginToString (UserStatistics function): Difference between revisions
m (→Syntax terms) |
|||
| 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> | ||
Revision as of 13:43, 13 April 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. By default, LoginToString will only include those Login statistics with non-zero values; but, optionally, 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 NameRequired 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 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='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.