RequestValue (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to syntax template, tags and edits) |
|||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:RequestValue subtitle}} | {{Template:UserStatistics:RequestValue subtitle}} | ||
<var>RequestValue</var> returns the value of a | <var>RequestValue</var> returns the value of a [[UserStatistics class#request|Request]] statistic. | ||
==Syntax== | ==Syntax== | ||
{{Template:UserStatistics:RequestValue syntax}} | {{Template:UserStatistics:RequestValue syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A numeric variable to contain the value of the specified statistic that is contained in the method object. </td></tr> | <td>A numeric variable to contain the value of the specified statistic that is contained in the method object. </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>string</th> | <tr><th>string</th> | ||
<td>This case-independent string contains the name of a <var class="product">Model 204</var> user statistic. Only the names of <var class="product">Model 204</ | <td>This case-independent string contains the name of a <var class="product">Model 204</var> user statistic. Only the names of <var class="product">Model 204</var> Request statistics are valid. All other names return an <var>[[UnknownStatistic_class|UnknownStatistic]]</var> exception.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li><var>RequestValue</var> cancels the request if it is applied to a statistic that is exclusively a | <li><var>RequestValue</var> cancels the request if it is applied to a statistic that is exclusively a [[UserStatistics class#login|Login]] (also called "Final") statistic. | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
The following statements print a Request statistic value: | |||
<p class="code"> | <p class="code">%stat is object userStatistics auto new | ||
print 'PDL highwater mark: ' %stat:requestValue('pdl') | |||
</p> | |||
</p | |||
==See also== | ==See also== | ||
<ul><li><var>[[Value (UserStatistics function)|Value]]</var> returns the value of a <var class="product">Model 204</var> user | <ul> | ||
<li><var>[[Value (UserStatistics function)|Value]]</var> returns the value of a <var class="product">Model 204</var> user Login statistic. | |||
</ul> | </ul> | ||
{{Template:UserStatistics:RequestValue footer}} | {{Template:UserStatistics:RequestValue footer}} | ||
Latest revision as of 23:30, 8 April 2014
Value of the specified Request statistic (UserStatistics class)
RequestValue returns the value of a Request statistic.
Syntax
%number = userStatistics:RequestValue( string) Throws UnknownStatistic
Syntax terms
| %number | A numeric variable to contain the value of the specified statistic that is contained in the method object. |
|---|---|
| userStatistics | A UserStatistics object variable. |
| string | This case-independent string contains the name of a Model 204 user statistic. Only the names of Model 204 Request statistics are valid. All other names return an UnknownStatistic exception. |
Usage notes
- RequestValue cancels the request if it is applied to a statistic that is exclusively a Login (also called "Final") statistic.
Examples
The following statements print a Request statistic value:
%stat is object userStatistics auto new print 'PDL highwater mark: ' %stat:requestValue('pdl')
See also
- Value returns the value of a Model 204 user Login statistic.