$ErrMsg: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<p>The $ | <p>The <var>$ErrMsg</var> function returns a string containing the prefix and text of the last counting error message or request cancellation message received by the user. </p> | ||
<p>A null value is returned if no counting error or request cancellation message has been received since:</p> | <p>A null value is returned if no counting error or request cancellation message has been received since:</p> | ||
<ul> | <ul> | ||
| Line 11: | Line 11: | ||
<p>Refer to the Rocket <var class="product">Model 204</var> Messages Manual for more information on counting messages. This function takes no arguments. </p> | <p>Refer to the Rocket <var class="product">Model 204</var> Messages Manual for more information on counting messages. This function takes no arguments. </p> | ||
<b>Example</b> | <b>Example</b> | ||
<p>A sample $ | <p>A sample <var>$ErrMsg</var> function with an <var>On Error</var> unit follows. To learn about <var>On Error</var> units, see [[Subroutines#ON units|ON units]].</p> | ||
<p class="code">begin | <p class="code">begin | ||
error.proc: on error | error.proc: on error | ||
| Line 33: | Line 33: | ||
<li>the [[IFGERR IFAM function]] | <li>the [[IFGERR IFAM function]] | ||
<li><var>[[$FSTERR]]</var>, which returns the <b>first</b> counting error message. | <li><var>[[$FSTERR]]</var>, which returns the <b>first</b> counting error message. | ||
<li>The <var>[[ | <li>The <var>[[ErrMsgL parameter|ERRMSGL]]</var>, which determines the length of errors returned by <var>$ErrMsg</var> and <var>$FstErr</var>. | ||
</ul> | </ul> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Revision as of 22:40, 26 April 2014
The $ErrMsg function returns a string containing the prefix and text of the last counting error message or request cancellation message received by the user.
A null value is returned if no counting error or request cancellation message has been received since:
- The beginning of the user's Model 204 session
- The last call to the $ERRCLR function.
- Processing a User Language OPEN statement
Refer to the Rocket Model 204 Messages Manual for more information on counting messages. This function takes no arguments.
Example
A sample $ErrMsg function with an On Error unit follows. To learn about On Error units, see ON units.
begin error.proc: on error print 'The request is ending' print 'The last error message received was:' print $errMsg end on get.recs: find all records for which agent = casola end find for each record in get.recs . . . end for end
The maximum length of the returned string is determined by the setting of the ERRMSGL parameter. That parameter defaults to 80 which means a maximum of 79 characters are returned, but ERRMSGL can be set as high as 256 which means up to 255 characters would be returned.
See also
- the IFGERR IFAM function
- $FSTERR, which returns the first counting error message.
- The ERRMSGL, which determines the length of errors returned by $ErrMsg and $FstErr.