$Stat: Difference between revisions
Jump to navigation
Jump to search
m (add link) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<p>The $ | <p> | ||
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 $ | |||
<p class="code">$ | ==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> | <p>Where:</p> | ||
<ul> | <ul> | ||
<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><var class="term">user</var> specifies the return of a user final or partial statistic. </li> | ||
</li> | |||
</ul> | </ul> | ||
<p class="code"> | ==Example== | ||
<p class="code"> ... | |||
%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') ...