RequestToString (UserStatistics function): Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 8: | Line 8: | ||
{{Template:UserStatistics:RequestToString syntax}} | {{Template:UserStatistics:RequestToString syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th><i>%ls</i></th> | ||
< | <td>A longstring variable to contain the listing of the values of the Request statistics. </td></tr> | ||
Request statistics. | <tr><th><i>%ustat</i></th> | ||
< | <td>A UserStatistics object variable. </td></tr> | ||
< | <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> | ||
< | </table> | ||
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. | |||
</ | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The [[LoginToString (UserStatistics function)|LoginToString]] function | <li>The [[LoginToString (UserStatistics function)|LoginToString]] function | ||
returns the values of the [[UserStatistics class#login|Login]] | returns the values of the [[UserStatistics class#login|Login]] | ||
(also called &ldquo;Final&rdquo;) statistics. | (also called &amp;ldquo;Final&amp;rdquo;) statistics. | ||
in the UserStatistics object. | in the UserStatistics object. | ||
The [[ToString (UserStatistics function)|ToString]] function | The [[ToString (UserStatistics function)|ToString]] function | ||
Revision as of 20:42, 14 March 2011
Request statistics in string format (UserStatistics class)
This method returns the values of the Request statistics
in the method UserStatistics object.
It prints all Request statistics with non-zero values (by default),
or it prints all Request statistics (as an option).
Syntax
%string = userStatistics:RequestToString[( [Zeros= boolean], - [NamesToLower= boolean])]
Syntax terms
| %ls | A longstring variable to contain the listing of the values of the Request 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. |
Usage notes
- The LoginToString function returns the values of the Login (also called &ldquo;Final&rdquo;) statistics. in the UserStatistics object. The ToString function returns the values of the Login and the Request statistics in the object.
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