LoginToString (UserStatistics function): Difference between revisions
m (1 revision) |
m (→Syntax terms) |
||
| Line 14: | Line 14: | ||
<tr><th><b>Zeros= </b><i>bool</i></th> | <tr><th><b>Zeros= </b><i>bool</i></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 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> | ||
<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> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
Revision as of 14:34, 30 March 2011
Login statistics in string format (UserStatistics class)
This function returns the values of the 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
%string = userStatistics:LoginToString[( [Zeros= boolean], - [NamesToLower= boolean])]
Syntax terms
| %ls | A longstring variable to contain the listing of the values of the Login statistics. |
|---|---|
| %ustat | A UserStatistics object variable. |
| Zeros= bool | 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. |
Usage notes
- The RequestToString function returns the values of the Request statistics in the UserStatistics object. The ToString function returns the values of all the statistics in the object.
Examples
The following example of non-zero Login statistics is produced by a
Print %ustat:loginToString 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