$ERROR: Difference between revisions

Revision as of 11:59, 11 July 2022

The $ERROR metacommand triggers a compilation error.

$ERROR message

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.

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.

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

@@ Line 1: / Line 1: @@
-The '''$ERROR''' metacommand triggers a compilation error.
+The '''$ERROR''' [[metacommand]] triggers a compilation error.
@@ Line 9: / Line 9: @@
 * This metacommand does not require a comment ''[[Apostrophe|&apos;]]'' or [[REM]] before it.
 * {{Parameter|message}} is any text. Quotation marks are not required.
-* When QB64 tries to compile an $ERROR metacommand a compilation error is triggered and {{Parameter|message}} is shown to the user. This is useful in [[$IF]] blocks.
+* When QB64 tries to compile an '''$ERROR''' metacommand a compilation error is triggered and {{Parameter|message}} is shown to the user. This is useful in [[$IF]] blocks.