Value (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (match syntax table to syntax template, tags and edits) |
||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:Value subtitle}} | {{Template:UserStatistics:Value subtitle}} | ||
<var>Value</var> returns the value of a <var class="product">Model 204</var> user <var>[[UserStatistics class#login|Login]]</var> (also called "Final") statistic. | |||
==Syntax== | ==Syntax== | ||
{{Template:UserStatistics:Value syntax}} | {{Template:UserStatistics:Value syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%number</th> | ||
<td>A numeric variable | <td>A numeric variable that will be assigned the value of the specified statistic contained in the method object.</td></tr> | ||
<tr><th> | <tr><th>userStatistics</th> | ||
<td>A UserStatistics object variable. </td></tr> | <td>A <var>UserStatistics</var> object variable. </td></tr> | ||
<tr><th> | <tr><th>string</th> | ||
<td>This case-independent string contains the name of a | <td>This case-independent string contains the name of a <var class="product">Model 204</var> user statistic. The names of all "final" or "partial" statistics supported by the <var class="product">Model 204</var> $STAT function are valid. The <var>OBJSWAP</var> statistic for <var>[[Janus SOAP]]</var> objects is also valid. All other names return an <var>[[UnknownStatistic_class|UnknownStatistic]]</var> exception.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified | <li><var>Value</var> cancels the request if it is applied to a statistic that is exclusively a <var>[[UserStatistics class#request|Request]]</var> statistic. | ||
without the parentheses: for example, | <li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example, UpdtTimeMs and LongUpdtimeMs, respectively. | ||
UpdtTimeMs and LongUpdtimeMs, respectively | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
<ol><li>The following statements validly assign and print statistic values: | |||
<p class="code">%cpu = %stat:value('cpu') | |||
[[PrintText statement|printText]] Object swaps: {%stat:value('OBJSWAP')} | |||
</p></ol> | |||
==See also== | ==See also== | ||
<ul><li><var>[[RequestValue (UserStatistics function)|RequestValue]]</var> returns the value of a <var class="product">Model 204</var> request statistic.</ul> | |||
{{Template:UserStatistics:Value footer}} | {{Template:UserStatistics:Value footer}} | ||
Revision as of 03:42, 1 April 2011
Value of the specified Login statistic (UserStatistics class)
Value returns the value of a Model 204 user Login (also called "Final") statistic.
Syntax
%number = userStatistics:Value( string) Throws UnknownStatistic
Syntax terms
| %number | A numeric variable that will be assigned the value of the specified statistic contained in the method object. |
|---|---|
| userStatistics | A UserStatistics object variable. |
| string | This case-independent string contains the name of a Model 204 user statistic. The names of all "final" or "partial" statistics supported by 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
- Value cancels the request if it is applied to a statistic that is exclusively a Request statistic.
- The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example, UpdtTimeMs and LongUpdtimeMs, respectively.
Examples
- The following statements validly assign and print statistic values:
%cpu = %stat:value('cpu') printText Object swaps: {%stat:value('OBJSWAP')}
See also
- RequestValue returns the value of a Model 204 request statistic.