RequestToString (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to syntax template, tags and edits) |
mNo edit summary |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:RequestToString subtitle}} | {{Template:UserStatistics:RequestToString subtitle}} | ||
The <var>RequestToString</var> method returns the values of the <var>[[UserStatistics class#request|Request]]</var> statistics in the method <var>UserStatistics</var> object. | The <var>RequestToString</var> method returns the values of the <var>[[UserStatistics class#request|Request]]</var> statistics in the method <var>UserStatistics</var> object. By default, it will only print those Request statistics with non-zero values; but, as an option, it may print all (including zero) Request statistics. | ||
==Syntax== | ==Syntax== | ||
{{Template:UserStatistics:RequestToString syntax}} | {{Template:UserStatistics:RequestToString syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th> | <tr><th>%string</th> | ||
<td>A <var>longstring</var> variable to contain the listing of the values of the <var>Request</var> statistics.</td></tr> | <td>A <var>longstring</var> variable to contain the listing of the values of the <var>Request</var> statistics.</td></tr> | ||
<tr><th>userStatistics</th> | <tr><th>userStatistics</th> | ||
<td>A <var>UserStatistics</var> object variable.</td></tr> | <td>A <var>UserStatistics</var> object variable.</td></tr> | ||
<tr><th>Zeros</th> | |||
<td>This | <tr><th><var>Zeros</var></th> | ||
<tr><th>NamesToLower</th><td>This | <td>This [[Notation conventions for methods#Named parameters|name required]] 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> | |||
<td>This name required 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== | ||
The following example of non-zero Request statistics is produced by a <code>print %ustat:requestToString</code> | |||
The following example of non-zero Request statistics is produced by a | statement: | ||
< | <p class="output">time='20080730102646772' userNumber=6 loginTime='20080730102645880' ntbl=10 qtbl=29 stbl=524 vtbl=51 pdl=508 cnct=1 - | ||
statement | cpu=887 out=1 slic=71 pcpu=996 rqtm=889 dkpr=124750 objswap=250247 | ||
<p class="output">time='20080730102646772' userNumber=6 loginTime=' | </p> | ||
cpu=887 out=1 slic=71 pcpu=996 rqtm=889 dkpr=124750 | |||
</p | |||
==See also== | ==See also== | ||
<ul><li><var>[[LoginToString (UserStatistics function)|LoginToString]]</var> returns the values of the | <ul> | ||
<li><var>[[ToString (UserStatistics function)|ToString]]</var> returns the values of the | <li><var>[[LoginToString (UserStatistics function)|LoginToString]]</var> returns the values of the [[UserStatistics class#login|Login]] (also called "Final") statistics in the <var>UserStatistics</var> object. | ||
<li><var>[[ToString (UserStatistics function)|ToString]]</var> returns the values of the Login and the Request statistics in the object. | |||
</ul> | </ul> | ||
{{Template:UserStatistics:RequestToString footer}} | {{Template:UserStatistics:RequestToString footer}} | ||
Latest revision as of 21:58, 20 November 2012
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, as an option, it 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 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 Request statistics is produced by a print %ustat:requestToString
statement:
time='20080730102646772' userNumber=6 loginTime='20080730102645880' ntbl=10 qtbl=29 stbl=524 vtbl=51 pdl=508 cnct=1 - cpu=887 out=1 slic=71 pcpu=996 rqtm=889 dkpr=124750 objswap=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.