clean-up

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

Syntax

(clean-up)

Description

The 'clean-up' function aborts one level of the break loop. This is valid for breaks , errors and cerrors [continuable errors]. If 'clean-up' is evaluated while not in a break loop , an error is generated:

error: not in a break loop

This error does not cause XLISP to go into a break loop. 'clean-up' never actually returns a value.

Examples

(clean-up)     ; [back to previous break level]
(break "out")  ; break: out
(clean-up)     ; to exit out of break loop

Note: With Nyquist, no error is generated if 'clean-up' is invoked when not in a break loop.

Keystroke equivalent: In the IBM PC and MS-DOS versions of XLISP, a 'Ctrl-g' key sequence has the same effect as doing a (clean-up). On a Macintosh, this can be accomplished by a pull-down menu or a 'Command-g'. [I haven't tested this with Nyquist].

See the clean-up function in the XLISP 2.0 manual.

  Back to Top