$ErrSet: Difference between revisions
Jump to navigation
Jump to search
m (minor cleanup) |
(Automatically generated page update) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Increment or clear number of counting errors, set $Errmsg</span> | <span class="pageSubtitle">Increment or clear number of counting errors, set $Errmsg</span> | ||
<p class="warn"><b>Note: </b> | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ErrSet function.</p> | ||
This function allows you to set or clear the current error message (which is returned by <var>[[$Errmsg]]</var>) and to increment or clear the number of "counting" errors. | This function allows you to set or clear the current error message (which is returned by <var>[[$Errmsg]]</var>) and to increment or clear the number of "counting" errors. | ||
The <var>$ErrSet</var> function accepts one argument and returns a number indicating the current number of counting errors. It is a [[Calling Sirius Mods $functions|callable]] $function. | The <var>$ErrSet</var> function accepts one argument and returns a number indicating the current number of counting errors. It is a [[Calling Sirius Mods $functions|callable]] $function. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">[<span class="term">%count</span> =] $ErrSet(<span class="term"string</span>) | <p class="syntax">[<span class="term">%count</span> =] $ErrSet(<span class="term">string</span>) | ||
</p> | </p> | ||
< | Where: | ||
% | <table> | ||
<tr><th>%count</th><td>The number of "counting" errors.</td></tr> | |||
<tr><th>string</th><td>A string indicating the message to be returned by the next <var>$Errmsg</var> call. If this argument is omitted or null, the current error message is cleared and the number of counting errors is set to 0; otherwise the number of counting errors is incremented.</td></tr> | |||
</table> | |||
==Example== | |||
The following statement sequence sets <code>%junk</code> to <code>NASTY ERROR</code> and increments the number of counting errors. | |||
<p class="code">%count = $ErrSet('NASTY ERROR') | <p class="code">%count = $ErrSet('NASTY ERROR') | ||
%junk = $Errmsg | %junk = $Errmsg | ||
</p> | </p> | ||
You can also change the number of counting errors (the | <p class="note"><b>Note:</b> You can also change the number of counting errors (the <var>[[ERCNT parameter|ERCNT]]</var> parameter) with <var>[[$Resetn]]</var>. </p> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
Latest revision as of 22:51, 20 September 2018
Increment or clear number of counting errors, set $Errmsg
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ErrSet function.
This function allows you to set or clear the current error message (which is returned by $Errmsg) and to increment or clear the number of "counting" errors.
The $ErrSet function accepts one argument and returns a number indicating the current number of counting errors. It is a callable $function.
Syntax
[%count =] $ErrSet(string)
Where:
| %count | The number of "counting" errors. |
|---|---|
| string | A string indicating the message to be returned by the next $Errmsg call. If this argument is omitted or null, the current error message is cleared and the number of counting errors is set to 0; otherwise the number of counting errors is incremented. |
Example
The following statement sequence sets %junk to NASTY ERROR and increments the number of counting errors.
%count = $ErrSet('NASTY ERROR') %junk = $Errmsg
Note: You can also change the number of counting errors (the ERCNT parameter) with $Resetn.