RequestValue (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (→Examples) |
m (→Examples) |
||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:RequestValue subtitle}} | |||
This function returns the value of a [[UserStatistics class#request|Request statistic]]. | This function returns the value of a [[UserStatistics class#request|Request statistic]]. | ||
| Line 12: | Line 6: | ||
that is exclusively a [[UserStatistics class#login|Login]] | that is exclusively a [[UserStatistics class#login|Login]] | ||
(also called Final) statistic. | (also called Final) statistic. | ||
==Syntax== | |||
{{Template:UserStatistics:RequestValue syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<dl> | <dl> | ||
| Line 27: | Line 21: | ||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The [[Value (UserStatistics function)|Value]] function returns the value of a | <li>The [[Value (UserStatistics function)|Value]] function returns the value of a | ||
''Model 204'' user Login statistic. | ''Model 204'' user Login statistic. | ||
</ul> | </ul> | ||
==Examples== | |||
The following statements respectively assign | The following statements respectively assign | ||
| Line 40: | Line 34: | ||
printText PDL highwater mark: {%stat:requestValue('PDL')} | printText PDL highwater mark: {%stat:requestValue('PDL')} | ||
</p> | </p> | ||
==See also== | |||
{{Template:UserStatistics:RequestValue footer}} | |||
Revision as of 20:42, 14 March 2011
Value of the specified Request statistic (UserStatistics class)
This function returns the value of a Request statistic.
The method cancels the request if it is applied to a statistic that is exclusively a Login (also called Final) statistic.
Syntax
%number = userStatistics:RequestValue( string) Throws UnknownStatistic
Syntax terms
- %val
- A numeric variable to contain the value of the specified statistic that is contained in the method object.
- %ustat
- A UserStatistics object variable.
- statistic
- 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
- The Value function returns the value of a Model 204 user Login statistic.
Examples
The following statements respectively assign and print a Request statistic value:
%num = %stat:requestValue('dkpr') printText PDL highwater mark: {%stat:requestValue('PDL')}