RequestValue (UserStatistics function)

From m204wiki
Revision as of 10:18, 31 March 2011 by Goff (talk | contribs) (match syntax table to syntax template, tags and edits)
Jump to navigation Jump to search

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

  1. 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.