RequestToString (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
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>

Revision as of 20:32, 24 May 2011

Request statistics in string format (UserStatistics class)

The RequestToString method returns the values of the Request statistics in the method UserStatistics object. By default, it will only print those Request statistics with non-zero values; but, optionally, may print all (including zero) Request statistics.

Syntax

%string = userStatistics:RequestToString[( [Zeros= boolean], - [NamesToLower= boolean])]

Syntax terms

%string A longstring variable to contain the listing of the values of the Request 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 Request statistics is produced by a print %ustat:requestToString statement. The output line wrapping is altered for display purposes.

time='20080730102646772' userNumber=6 loginTime='200807301- 02645880' ntbl=10 qtbl=29 stbl=524 vtbl=51 pdl=508 cnct=1 - cpu=887 out=1 slic=71 pcpu=996 rqtm=889 dkpr=124750 objswa- p=250247

See also

  • LoginToString returns the values of the Login (also called "Final") statistics in the UserStatistics object.
  • ToString returns the values of the Login and the Request statistics in the object.