Value (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b>Value of specified Login statistic</b></span>
{{Template:UserStatistics:Value subtitle}}
[[Category:UserStatistics methods|Value function]]
<var>Value</var> returns the value of a <var class="product">Model 204</var> user [[UserStatistics class#login|Login]] (also called "Final") statistic.
<!--DPL?? Category:UserStatistics methods|Value function: Value of specified Login statistic-->
<!--DPL?? Category:System methods|Value (UserStatistics function): Value of specified Login statistic-->
<p>
Value is a member of the [[UserStatistics class]].
</p>


This method returns the value of a ''Model 204'' user [[UserStatistics class#login|Login]]
==Syntax==
(also called &ldquo;Final&rdquo;) statistic.
{{Template:UserStatistics:Value syntax}}


The method cancels the request if it is applied to a statistic
that is exclusively a [[UserStatistics class#request|Request statistic]].
===Syntax===
  %val = %ustat:Value(statistic)
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%val</i>
<tr><th>%number</th>
<dd>A numeric variable to contain the value of the specified statistic
<td>A numeric variable that will be assigned the value of the specified statistic contained in the method object.</td></tr>
contained in the method object.
 
<dt><i>%ustat</i>
<tr><th>userStatistics</th>
<dd>A UserStatistics object variable.
<td>A <var>UserStatistics</var> object variable. </td></tr>
<dt><i>statistic</i>
 
<dd>This case-independent string contains the name of a ''Model 204'' user statistic.
<tr><th>string</th>
The names of final or partial statistics available to the ''Model 204'' $STAT function
<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 class="product">[[Janus SOAP]]</var> objects is also valid. All other names return an <var>[[UnknownStatistic_class|UnknownStatistic]]</var> exception.</td></tr>
are valid.
</table>
The OBJSWAP statistic for [[Janus SOAP]] objects is also valid.
All other names return an UnknownStatistic exception.


</dl>
==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 [[UserStatistics class#request|Request]] statistic.
without the parentheses: for example,
<li>The statistics <var>UpdtTime(MS)</var> and <var>LongupdTime(MS)</var> can also be specified without the parentheses: for example, <code>UpdtTimeMs</code> and <code>LongUpdtimeMs</code>, respectively.
UpdtTimeMs and LongUpdtimeMs, respectively.
<li>The [[RequestValue (UserStatistics function)|RequestValue]] function returns the value of a
''Model 204'' request statistic.
</ul>
</ul>
===Examples===


The following statements validly assign and print statistic values:
==Examples==
<pre>
The following statements validly assign and print statistic values:  
    %cpu = %stat:value('cpu')
<p class="code">%cpu = %stat:value('cpu')
 
[[PrintText statement|printText]] Object swaps: {%stat:value('OBJSWAP')}
</p>


    printText Object swaps: {%stat:value('OBJSWAP')}
==See also==
</pre>
<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}}

Latest revision as of 22:27, 20 November 2012

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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Value_(UserStatistics_function)&oldid=13659"