Value (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (→Examples) |
m (→Examples) |
||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:Value subtitle}} | |||
This method returns the value of a ''Model 204'' user [[UserStatistics class#login|Login]] | This method returns the value of a ''Model 204'' user [[UserStatistics class#login|Login]] | ||
(also called “Final”) statistic. | (also called “Final”) statistic. | ||
The method cancels the request if it is applied to a statistic | The method cancels the request if it is applied to a statistic | ||
that is exclusively a [[UserStatistics class#request|Request statistic]]. | that is exclusively a [[UserStatistics class#request|Request statistic]]. | ||
==Syntax== | |||
{{Template:UserStatistics:Value syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<dl> | <dl> | ||
| Line 29: | Line 23: | ||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified | <li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified | ||
| Line 37: | Line 31: | ||
''Model 204'' request statistic. | ''Model 204'' request statistic. | ||
</ul> | </ul> | ||
==Examples== | |||
The following statements validly assign and print statistic values: | The following statements validly assign and print statistic values: | ||
| Line 44: | Line 38: | ||
printText Object swaps: {%stat:value('OBJSWAP')} | printText Object swaps: {%stat:value('OBJSWAP')} | ||
</p> | </p> | ||
==See also== | |||
{{Template:UserStatistics:Value footer}} | |||
Revision as of 20:42, 14 March 2011
Value of the specified Login statistic (UserStatistics class)
This method returns the value of a Model 204 user Login
(also called “Final”) statistic.
The method cancels the request if it is applied to a statistic that is exclusively a Request statistic.
Syntax
%number = userStatistics:Value( string) Throws UnknownStatistic
Syntax terms
- %val
- A numeric variable to contain the value of the specified statistic contained in the method object.
- %ustat
- A UserStatistics object variable.
- statistic
- This case-independent string contains the name of a Model 204 user statistic. The names of final or partial statistics available to the Model 204 $STAT function are valid. The OBJSWAP statistic for Janus SOAP objects is also valid. All other names return an UnknownStatistic exception.
Usage notes
- The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example, UpdtTimeMs and LongUpdtimeMs, respectively.
- The RequestValue function returns the value of a Model 204 request statistic.
Examples
The following statements validly assign and print statistic values:
%cpu = %stat:value('cpu') printText Object swaps: {%stat:value('OBJSWAP')}