$IncStat: Difference between revisions
No edit summary |
(Automatically generated page update) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Increment local system statistic</span> | <span class="pageSubtitle">Increment local system statistic</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Most Sirius $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 10 local system statistics that can be incremented with $IncStat. These stats can be examined via $SyStat under the names LOCAL0 through LOCAL9. | This function allows a user to increment the current value of a local system statistic. There are 10 local system statistics that can be incremented with $IncStat. These stats can be examined via $SyStat under the names LOCAL0 through LOCAL9. | ||
Revision as of 20:51, 18 July 2013
Increment local system statistic
Note: Most Sirius $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 10 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.
The first 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 second 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.
Syntax
%value = $IncStat(stat_num, [value])
%value is set to either 0 or to the value argument.
Example
The code fragment
%value = $IncStat(2)
adds 1 to local stat number 2.