$Fsterr: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
m (link repair)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<p>The $FSTERR function returns a variable length string of up to 79 characters that contains the prefix and the first counting error message or request cancellation message you received since the last time that the count was reset to zero. $FSTERR returns a null value, if <var class="product">Model&nbsp;204</var> has not received a counting error or request cancellation message since:</p>
<p>
The <var>$Fsterr</var> function returns a string containing the prefix and text of the first [[Introduction to User Language#Counting errors|counting error]] message or request cancellation message received by the user. </p>
 
==Syntax==
<p>
This function takes no arguments. </p>
 
==Usage notes==
<ul>
<li>A null value is returned if no counting error or request cancellation message has been received since:
<ul>
<ul>
<li>The beginning of your <var class="product">Model&nbsp;204</var> session</li>
<li>The beginning of the user's <var class="product">Model&nbsp;204</var> session</li>
</li>
 
<li>The last call to the $ERRCLR function</li>
<li>The last call to the <var>[[$ErrClr]]</var> function</li>
</li>
 
<li>Processing a User Language OPEN statement</li>
<li>Processing a <var class="product">SOUL</var> <var>Open</var> statement</li>
</li>
</ul></li>
 
<li>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. </li>
 
<li><var>$Fsterr</var> is not available for Host Language Interface applications. </li>
 
<li>The <var>$Fsterr</var> function requires an additional 88 bytes in the fixed portion of the server.</li>
</ul>
</ul>
<p>For more information about counting errors or request cancellation messages, refer to the Rocket <var class="product">Model&nbsp;204</var> Messages Manual. To return the most recent error message, refer to the $ERRMSG function. $FSTERR is not available for Host Language Interface applications. The $FSTERR function takes no arguments.</p>
<p>The $FSTERR function requires an additional 88 bytes in the fixed portion of the server.</p>
<b>Example</b>
<p>An example of the $FSTERR function with an ON ERROR unit follows. For more information, refer to [[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
==Example==
                   AGENT = BLAKE
<p>
               END FIND
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>
               FOR EACH RECORD IN GET.RECS
<p class="code">begin
              .
fsterr.proc:  on error
                .
                  print 'The request is ending'
                END FOR
                  print 'The first error message was:'
END
                  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>
==See also==
<ul>
<li><var>IFGERR</var> <var class="product">[[Media:M204_HLIReference_V75.pdf|IFAM]]</var> function </li>
<li><var>[[$Errmsg]]</var>, which returns the <b>most recent</b> counting error message. </li>
<li>The <var>[[ERRMSGL parameter|ERRMSGL]]</var> parameter, which determines the length of errors returned by <var>$Errmsg</var> and <var>$Fsterr</var>.</li>
</ul>
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Latest revision as of 20:10, 2 March 2015

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.

Syntax

This function takes no arguments.

Usage notes

  • 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
  • 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.
  • $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

See also

  • 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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Fsterr&oldid=76375"