$ERROR

From QB64 Phoenix Edition Wiki
Revision as of 17:16, 25 November 2022 by RhoSigma (talk | contribs)
Jump to navigation Jump to search

The $ERROR metacommand triggers a compilation error.


Syntax

$ERROR message


Description

  • This metacommand does not require a comment ' or REM before it.
  • message is any text. Quotation marks are not required.
  • When QB64 tries to compile an $ERROR metacommand a compilation error is triggered and message is shown to the user. This is useful in $IF blocks.


Description

  • If there is a particular situation where you know your program will not work properly, you can prevent the user compiling and give them a helpful error message instead by checking for the condition with $IF.
  • An $ERROR directive not inside an conditional $IF (or $ELSEIF) block is useless because the program will never compile in that case.


Examples

$IF VERSION < 2.1 OR WINDOWS = 0 THEN
    $ERROR Requires Windows QB64 version 2.1 or above
$END IF
Output (IDE Status Area)
Compilation check failed: REQUIRES WINDOWS QB64 VERSION 2.1 OR ABOVE on line 2 (assuming your version of QB64 doesn't meet those requirements).


See also



Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link