Nyquist / XLISP 2.0  -  Contents | Tutorials | Examples | Reference

break


Type:   -   function (subr)
Source:   -   xlbfun.c, xldbug.c

Syntax

(break [err-msg [arg]])
err-msg - a string expression for the error message
arg - an optional argument expression
returns - NIL when continued from the break loop

Description

The 'break' function allows the entry into the Break Loop with a continuable error. The continuable error generated by 'break' does not require any corrective action. The form of the message generated is:

break: err-msg - arg
if continued: return from BREAK

The default for 'err-msg' is:

**BREAK**

From within the Break Loop, if a continue form is evaluated then NIL is returned from 'break'. If desired, the clean-up or top-level functions may be evaluated to abort the Break Loop.

Examples

> (break)
break: **BREAK**
if continued: return from BREAK

> (break "out")
break: out
if continued: return from BREAK

> (break "it" "up")
break: it - "up"
if continued: return from BREAK

See also:

  Back to Top


Nyquist / XLISP 2.0  -  Contents | Tutorials | Examples | Reference