Value (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 2: | Line 2: | ||
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 | ||
| Line 9: | Line 9: | ||
{{Template:UserStatistics:Value syntax}} | {{Template:UserStatistics:Value 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 contained in the method object. </td></tr> | ||
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. 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.</td></tr> | ||
< | </table> | ||
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== | ==Usage notes== | ||
<ul> | <ul> | ||
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 &ldquo;Final&rdquo;) 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')}