RequestValue (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 23: Line 23:


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



Revision as of 22:48, 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 printText PDL highwater mark: {%stat:requestValue('pdl')}

See also

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