$Stat: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
m (add link)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<p>The $STAT function returns the current value of any user final (LOGOUT) or partial statistic. This function is useful for determining which resources are used by various portions of a request. </p>
<p>
<b>Syntax</b>
The <var>$Stat</var> function returns the current value of any user final (LOGOUT) or partial statistic. This function is useful for determining which resources are used by various portions of a request. </p>
<p>The format of the $STAT function is:</p>
 
<p class="code">$STAT(statistic,'user')  
==Syntax==
<p>
The format of the <var>$Stat</var> function is:</p>
<p class="code">$Stat(<span class="term">statistic</span>,'<span class="term">user</span>')  
</p>
</p>
<p>where:</p>
<p>Where:</p>
<ul>
<ul>
<li>statistic specifies the name of the user statistic to be returned. Refer to the Rocket <var class="product">Model&nbsp;204</var> System Manager's Guide for a complete list of user statistic names and meanings.</li>
<li><var class="term">statistic</var> specifies the name of the [[Using system statistics#User statistics entries (Type 9)|user statistic]] to be returned. </li>
</li>
 
<li>user specifies the return of a user final or partial statistic. </li>
<li><var class="term">user</var> specifies the return of a user final or partial statistic. </li>
</li>
</ul>
</ul>
<b>Example</b>
 
<p class="code">     .
==Example==
    .
<p class="code">   ...
    .
%x = $stat('CPU','USER')
%X = $STAT('CPU','USER')
  ...
    .
    .
    .  
</p>
</p>
==See also==
<ul>
<li>[[UserStatistics class]] </li>
</ul>
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Latest revision as of 22:53, 25 January 2016

The $Stat function returns the current value of any user final (LOGOUT) or partial statistic. This function is useful for determining which resources are used by various portions of a request.

Syntax

The format of the $Stat function is:

$Stat(statistic,'user')

Where:

  • statistic specifies the name of the user statistic to be returned.
  • user specifies the return of a user final or partial statistic.

Example

... %x = $stat('CPU','USER') ...

See also