$SetStat: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Automatically generated page update) |
||
| (27 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$SetStat}} | {{DISPLAYTITLE:$SetStat}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Set local system statistic</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $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 | This function allows a user to set the current value of a local system statistic. There are ten local system statistics that can be set via <var>$SetStat</var>. These stats can be examined via <var>$SyStat</var> under the names <code>LOCAL0</code> through <code>LOCAL9</code>. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%value</span> = <span class="literal">$SetStat</span>(<span class="term">stat_num</span>, [<span class="term">value</span>]) | ||
< | |||
< | |||
</p> | </p> | ||
===Syntax terms=== | |||
<table class="syntaxTable"> | |||
<tr><th>%value</th> | |||
<td>A variable that is set to <var class="term">value</var>, the new value of the appropriate local statistic, or it is set to 0 if there is an error.</td></tr> | |||
<tr><th>stat_num</th> | |||
<td>The local stat number to be set. If this number is not in the range 0 through 9, <var>$SetStat</var> performs no action and returns a 0. </td></tr> | |||
<tr><th>value</th> | |||
< | <td>A number that indicates the value to which the local stat is to be set. This is an optional argument that defaults to 0.</td></tr> | ||
</ | </table> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>[[Sirius | <li>This function can be used to initialize a local statistic. For example, this code fragment initializes local stat number 1 to 0: | ||
<p class="code">%value = $SetStat(1)</p> | |||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | |||
<li>[[List of $functions|Sirius functions]] | |||
<li>[[SirMon]] | <li>[[SirMon]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$SetStat]] | [[Category:$Functions|$SetStat]] | ||
Latest revision as of 22:52, 20 September 2018
Set local system statistic
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $SetStat function.
This function allows a user to set the current value of a local system statistic. There are ten local system statistics that can be set via $SetStat. These stats can be examined via $SyStat under the names LOCAL0 through LOCAL9.
Syntax
%value = $SetStat(stat_num, [value])
Syntax terms
| %value | A variable that is set to value, the new value of the appropriate local statistic, or it is set to 0 if there is an error. |
|---|---|
| stat_num | The local stat number to be set. If this number is not in the range 0 through 9, $SetStat performs no action and returns a 0. |
| value | A number that indicates the value to which the local stat is to be set. This is an optional argument that defaults to 0. |
Usage notes
- This function can be used to initialize a local statistic. For example, this code fragment initializes local stat number 1 to 0:
%value = $SetStat(1)