RequestValue (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 9: | Line 9: | ||
{{Template:UserStatistics:RequestValue syntax}} | {{Template:UserStatistics:RequestValue syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th><i>%val</i></th> | ||
< | <td>A numeric variable to contain the value of the specified statistic that is contained in the method object. </td></tr> | ||
that is contained in the method object. | <tr><th><i>%ustat</i></th> | ||
< | <td>A UserStatistics object variable. </td></tr> | ||
< | <tr><th><i>statistic</i></th> | ||
< | <td>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.</td></tr> | ||
< | </table> | ||
Only the names of ''Model 204'' Request statistics are valid. | |||
All other names return an UnknownStatistic exception. | |||
</ | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
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')}