View source for $SetStat

{{DISPLAYTITLE:$SetStat}}
<span class="pageSubtitle">Set local system statistic</span>

<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SetStat function.</p>

This function allows a user to set the current value of a local system statistic. There are 10 local system statistics that can be set via <var>$SetStat</var>. These stats can be examined via $SyStat under the names LOCAL0 through LOCAL9. 

The $SetStat function accepts two arguments and returns either the new value of the appropriate local statistic or a 0 if there is an error. 

The first argument is the local stat number to be set. This number must be 0 through 9 or the $SetStat performs no action and returns a 0. 

The second argument is a number that indicates the value to which the local stat is to be set. This is an optional argument and defaults to 0.
==Syntax==
<p class="syntax"><section begin="syntax" />%VALUE = $SetStat(stat_num, value)
<section end="syntax" /></p>
<p class="caption">$SetStat Function
</p>
<p class="caption">%VALUE is set to either 0 or '''value'''.</p>


This function can be used to initialize a local statistic. For example, the code fragment
<p class="code"> %VALUE = $SetStat(1)
</p>
initializes local stat number 1 to 0.

<h2>Products authorizing {{PAGENAMEE}}</h2><ul class="smallAndTightList">
<li>[[Sirius functions]]
<li>[[SirMon]]
</ul>
<p>
</p>

[[Category:$Functions|$SetStat]]