RequestValue (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax table to syntax template, tags and edits)
Line 20: Line 20:


==Examples==
==Examples==
<ol><li>The following statements assign and print a <var>Request</var> statistic value:
The following statements assign and print a <var>Request</var> statistic value:
<p class="code">%num = %stat:requestValue('dkpr')
<p class="code">%num = %stat:requestValue('dkpr')
   
   
[[PrintText statement|printText]] PDL highwater mark: {%stat:requestValue('PDL')}
[[PrintText statement|printText]] PDL highwater mark: {%stat:requestValue('PDL')}
</p></ol>
</p>


==See also==
==See also==

Revision as of 00:54, 3 May 2011

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 assign and print a Request statistic value:

%num = %stat:requestValue('dkpr') printText PDL highwater mark: {%stat:requestValue('PDL')}

See also

  • Value returns the value of a Model 204 user Login statistic.