RequestToString (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
 
(12 intermediate revisions by 5 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. 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.


This method returns the values of the [[UserStatistics class#request|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==
==Syntax==
{{Template:UserStatistics:RequestToString syntax}}
{{Template:UserStatistics:RequestToString syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%ls</i>
<tr><th>%string</th>
<dd>A longstring variable to contain the listing of the values of the
<td>A <var>longstring</var> variable to contain the listing of the values of the <var>Request</var> statistics.</td></tr>
Request statistics.
 
<dt><i>%ustat</i>
<tr><th>userStatistics</th>
<dd>A UserStatistics object variable.
<td>A <var>UserStatistics</var> object variable.</td></tr>
<dt><b>Zeros= </b><i>bool</i>
 
<dd>This name required argument (<tt>Zeros</tt>) is a boolean value
<tr><th><var>Zeros</var></th>
that indicates whether statistics with a zero value should be included
<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>
in the returned data.
 
Zeros is an optional argument that defaults to <tt>False</tt>, which
<tr><th><var>NamesToLower</var></th>
results in the inclusion of only statistics with non-zero values.
<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>


</dl>
==Usage notes==
<ul>
<li>The [[LoginToString (UserStatistics function)|LoginToString]] function
returns the values of the [[UserStatistics class#login|Login]]
(also called &amp;ldquo;Final&amp;rdquo;) statistics.
in the UserStatistics object.
The [[ToString (UserStatistics function)|ToString]] function
returns the values of the Login and the Request statistics in the object.
</ul>
==Examples==
==Examples==
The following example of non-zero Request statistics is produced by a <code>print %ustat:requestToString</code>
statement:
<p class="output">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
</p>


The following example of non-zero Request statistics is produced by a
<br>
<tt>Print %ustat:requestToString</tt> statement.
The output line wrapping is altered for display purposes.
<p class="code">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
</p>
==See also==
==See also==
<ul>
<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>
{{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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=RequestToString_(UserStatistics_function)&oldid=13602"