View source for $Fsterr

<p>The <var>$FstErr</var> function returns a string containing the prefix and text of the first 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>
<ul>
<li>The beginning of the user's <var class="product">Model&nbsp;204</var> session</li>
</li>
<li>The last call to the <var>[[$ERRCLR]]</var> function</li>
</li>
<li>Processing a <var class="product">SOUL</var> <var>Open</var> statement</li>
</li>
</ul>
<p>Refer to the Rocket <var class="product">Model&nbsp;204</var> Messages Manual for more information on counting messages. This function takes no arguments.             </p>
<p><var>$FstErr</var> is not available for Host Language Interface applications. </p>
<p>The <var>$FstErr</var> function requires an additional 88 bytes in the fixed portion of the server.</p>
<b>Example</b>
<p>A sample <var>$FstErr</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
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
</p>
<p>The maximum length of the returned string is determined by the setting of the <var>[[ERRMSGL parameter|ERRMSGL]]</var> parameter. That parameter defaults to 80 which means a maximum of 79 characters are returned, but <var>ERRMSGL</var> can be set as high as 256 which means up to 255 characters would be returned.
==See also==
<ul>
<li>the [[IFGERR IFAM function]]
<li><var>[[$ERRMSG]]</var>, which returns the <b>most recent</b> counting error message.
<li>The <var>[[ErrMsgL parameter|ERRMSGL]]</var> parameter, which determines the length of errors returned by <var>$ErrMsg</var> and <var>$FstErr</var>.
</ul>
[[Category:SOUL $functions]]