1
1
Fork 0
mirror of https://github.com/QB64-Phoenix-Edition/QB64pe.git synced 2024-06-29 10:30:36 +00:00
QB64-PE/internal/help/ON_ERROR.txt
SteveMcNeill 33adc04fc4 Add temp folder to repo. It's necessary as well!
Just more initial setting on... nothing much to see here.
2022-04-28 13:39:56 -04:00

72 lines
2.9 KiB
Plaintext

[[ON ERROR]] is used with [[GOTO]] to handle errors in a program.
{{PageSyntax}}
: [[ON ERROR]] [[GOTO]] {''lineNumber''|''lineLabel''}
{{PageDescription}}
* An ''untreated error'' in a program will cause execution to stop and an error message is displayed to the user, who can choose to continue (ignore the error - which could have unexpected results) or end the program.
* Use [[ON ERROR]] when your program performs operations that are likely to generate errors, like file access operations.
* [[ON ERROR]] statements can be in the main module code or in [[SUB]] or [[FUNCTION]] procedures.
* [[ON ERROR]] statements take precedence in the order they are encountered. It will also handle any subroutine errors.
* '''ON ERROR GOTO 0''' can be used to disable custom [[ON ERROR]] trapping and give default error messages.
* A subsequent ON ERROR statement will override the previous one.
* [[GOTO]] is required in the statement. Cannot use [[GOSUB]].
* Comment out [[ON ERROR]] to find specific error locations. QB64 can return the file line position with [[_ERRORLINE]]
* Note: QB64 does not support the PDS (QuickBASIC 7) '''ON ERROR RESUME NEXT''' statement.
{{PageExamples}}
''Example 1:'' Using an error handler that ignores any error.
{{CodeStart}} '' ''
{{Cl|ON ERROR}} {{Cl|GOTO}} Errhandler
' Main module program error simulation code
{{Cl|ERROR}} 7 ' simulate an Out of Memory Error
PRINT "Error handled...ending program"
{{Cl|SLEEP}} 4
{{Cl|SYSTEM}} ' end of program code
Errhandler: 'error handler sub program line label
PRINT "Error"; {{Cl|ERR}}; "on program file line"; {{Cl|_ERRORLINE}}
{{Cl|BEEP}} ' warning beep
{{Cl|RESUME}} NEXT ' moves program to code following the error. '' ''
{{CodeEnd}}
{{OutputStart}}
Error 7 on program file line 3
Error handled...ending program
{{OutputEnd}}
:''Explanation:'' The ON ERROR statement is normally placed at the beginning of the main module code. Errhandle is the line label sub referred to in the statement. The handler prints the error code and attempts to use the next line of code using [[RESUME]] NEXT which is only used in error handling procedures. [[_ERRORLINE]] returns the program file's actual text line count found in the IDE.
''Example 2:'' Using an error handler in a [[SUB]] procedure.
{{CodeStart}} '' ''
s
{{Cl|END}}
hand:
{{Cl|PRINT}} "got error!"
{{Cl|RESUME}} {{Cl|NEXT}}
{{Cl|SUB}} s
{{Cl|ON ERROR}} {{Cl|GOTO}} hand
{{Cl|ERROR}} 1
{{Cl|ON ERROR}} {{Cl|GOTO}} 0
{{Cl|PRINT}} "Done!"
{{Cl|END SUB}} '' ''
{{CodeEnd}}
: ''Explanation:'' The [[GOTO]] procedure must be in the main code area after [[END]] to avoid a [[RESUME]] error later. Use GOTO 0 to clear the ON ERROR set in the sub so that later errors are not handled by it.
{{PageSeeAlso}}
* [[ERR]], [[ERL]], [[RESUME]]
* [[ON...GOTO]]
* [[_ERRORLINE]], [[_INCLERRORLINE]], [[_INCLERRORFILE$]]
* [[ERROR]] {{text|(simulates an error)}}
* [[ERROR Codes]]
{{PageNavigation}}
<