$IncStat: Difference between revisions
(Created page with "{{DISPLAYTITLE:$IncStat}} <span class="pageSubtitle"><section begin="desc" />Increment local system statistic<section end="desc" /></span> <p class="warning">Most Sirius $functi...") |
(Automatically generated page update) |
||
| (22 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$IncStat}} | {{DISPLAYTITLE:$IncStat}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Increment 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 no OO equivalent for the $IncStat function.</p> | ||
This function allows a user to increment the current value of a local system statistic. There are | This function allows a user to increment the current value of a local system statistic. There are ten local system statistics that can be incremented with <var>$IncStat</var>. These stats can be examined via <var>$SyStat</var> under the names <code>LOCAL0</code> through <code>LOCAL9</code>. | ||
The $IncStat function accepts two arguments and returns either the new value of the appropriate local statistic or a 0 if there is an error. | The <var>$IncStat</var> function accepts two arguments and returns either the new value of the appropriate local statistic or a 0 if there is an error. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%value</span> = <span class="literal">$IncStat</span>(<span class="term">stat_num</span>, [<span class="term">value</span>]) | ||
< | |||
< | |||
</p> | </p> | ||
<p> | |||
< | <var class="term">%value</var> is set to either 0 or to the <var class="term">value</var> argument.</p> | ||
</ | |||
< | The <var class="term">stat_num</var> argument is a number that indicates the local stat number to be incremented. This number must be 0 through 9. Otherwise, the $IncStat performs no action and returns a 0. | ||
< | The <var class="term">value</var> argument is a number that indicates the value that will be added to the local stat. This is an optional argument and defaults to 1. | ||
< | ==Example== | ||
The following code fragment adds 1 to local stat number 2: | |||
<p class="code">%value = $IncStat(2) | |||
</p> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | |||
<li>[[List of $functions|Sirius functions]] | |||
<li>[[SirMon]] | |||
</ul> | </ul> | ||
[[Category:$Functions|$IncStat]] | [[Category:$Functions|$IncStat]] | ||
Latest revision as of 22:51, 20 September 2018
Increment local system statistic
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $IncStat function.
This function allows a user to increment the current value of a local system statistic. There are ten local system statistics that can be incremented with $IncStat. These stats can be examined via $SyStat under the names LOCAL0 through LOCAL9.
The $IncStat function accepts two arguments and returns either the new value of the appropriate local statistic or a 0 if there is an error.
Syntax
%value = $IncStat(stat_num, [value])
%value is set to either 0 or to the value argument.
The stat_num argument is a number that indicates the local stat number to be incremented. This number must be 0 through 9. Otherwise, the $IncStat performs no action and returns a 0.
The value argument is a number that indicates the value that will be added to the local stat. This is an optional argument and defaults to 1.
Example
The following code fragment adds 1 to local stat number 2:
%value = $IncStat(2)