Generate run-time error

Syntax

end [errorstring] [flags] [...]

Parameters

errorstring - error description. Can be string or variable of type QMERROR.

If used more than 2 arguments, errorstring is interpreted as format-string (see str.format). Tags are supported.

flags :

0-3

Where to generate error:

0 - in caller. If there is no direct caller - here. Default.
1 - here.
2 - in caller that is not class member function called for this variable.
3 - this flag is obsolete.
In caller of first function that is not in private folder. This flag does not work in exe.

Don't open function even if "Show run-time errors" is checked in Options.

QM 2.3.3. Generate warning.

... - values that are inserted into the format-string (errorstring).

Remarks

Generates run-time error, which ends thread (running macro) if not handled.

By default, if end is used in an user-defined function, the error is generated in caller (macro/function that called the function).

Caller can handle errors with err statement. Then it may want to know error code. It looks for it in code field of the _error variable. There are several ways to set error code when generating error:

Use an error constant as errorstring.
Prepend code (some number) to errorstring. Use error codes >= 2000.
Set code and description fields of _error, and use it as errorstring.

QM 2.3.3. If used flag 8, generates warning instead of error. It does not end macro. Just displays warning message in QM output. Flags 0-3 are applied. To disable such warnings, use opt nowarnings 1.

In function help you can see errors that the function may generate. QM displays errors from end statements used in that function, or errors explicitly specified in Errors: line.

If end is used without arguments (just end), it ends thread without generating error. This way of ending thread is rarely used. Instead use ret or generate error. In some cases it is better to use shutdown -7.

See also: opt end

Examples

end "file not found"
end "2000 my error description" ;;use an error code
end ERR_FILE ;;use an error constant

str filevariable="Z:\file"
end F"{ERR_FILE}: '{filevariable}'"

run "abc"
err
	_error.description + " abc"
	end _error

end ;;end thread without generating error