$ErrSet: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
(No difference)

Revision as of 20:32, 24 October 2012

Increment or clear number of counting errors, set $ERRMSG

Most Sirius $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. As of Sirius Mods Version 6.8, it is a callable $function .

The first argument is 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.

Syntax

<section begin="syntax" />[%COUNT =] $ErrSet(string) <section end="syntax" />

$ErrSet Function

%COUNT is the number of "counting" errors.

For example

%COUNT = $ErrSet('NASTY ERROR') %JUNK = $ERRMSG

would set %JUNK to 'NASTY ERROR' and would increment the number of counting errors.

You can also change the number of counting errors (the Sirius ERCNT parameter) with $Resetn.

Products authorizing $ErrSet