$Fsterr: Difference between revisions
No edit summary |
|||
| Line 4: | Line 4: | ||
<li>The beginning of the user's <var class="product">Model 204</var> session</li> | <li>The beginning of the user's <var class="product">Model 204</var> session</li> | ||
</li> | </li> | ||
<li>The last call to the <var>[[$ | <li>The last call to the <var>[[$ErrClr]]</var> function</li> | ||
</li> | </li> | ||
<li>Processing a <var class="product">SOUL</var> <var>Open</var> statement</li> | <li>Processing a <var class="product">SOUL</var> <var>Open</var> statement</li> | ||
| Line 34: | Line 34: | ||
<ul> | <ul> | ||
<li>the [[IFGERR IFAM function]] | <li>the [[IFGERR IFAM function]] | ||
<li><var>[[$ | <li><var>[[$Errmsg]]</var>, which returns the <b>most recent</b> counting error message. | ||
<li>The <var>[[ | <li>The <var>[[ERRMSGL parameter|ERRMSGL]]</var> parameter, 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 14:01, 1 August 2014
The $FstErr function returns a string containing the prefix and text of the first 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 SOUL Open statement
Refer to the Rocket Model 204 Messages Manual for more information on counting messages. This function takes no arguments.
$FstErr is not available for Host Language Interface applications.
The $FstErr function requires an additional 88 bytes in the fixed portion of the server.
Example
A sample $FstErr function with an On Error unit follows. To learn about On Error units, see ON units.
begin fsterr.proc: on error print 'The request is ending' print 'The first error message was:' print $fstErr end on get.recs: find all records for which agent = blake 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
- $Errmsg, which returns the most recent counting error message.
- The ERRMSGL parameter, which determines the length of errors returned by $Errmsg and $Fsterr.