Function Entry: CLAL-BREAK

← Prev | ↑ Chapter | Next → | Index | Symbols

Function Entry: CLAL-BREAK

Name

clal-break

Class

clautolisp Extension Function

Syntax

(clal-break)

Arguments and Values

No arguments.

Description

Drop into the aldo debugger at the current poll point, from AutoLISP code, when a debug session is active (debugger command reference §1, programmatic entry). It funcalls the runtime's debug-break hook with no message. When no debug session is running the hook is unbound, so the call is a plain no-op.

Return Values

Always nil (both when it stopped and when it was a no-op).

Side Effects

When a debug session is active, transfers control to the aldo debugger at the next poll point; otherwise none.

Affected By

  • Whether a debug session (aldo) is currently active — i.e. whether the runtime debug-break hook is installed.

Exceptional Situations

None. No arguments to validate; a no-op outside a debug session.

Examples

(defun f (x) (clal-break) (* x x))
(f 7)   ; stops in aldo before the multiply when a session is active
=> 49

Availability

  • clautolisp: documented (this entry); implemented since clautolisp 1.4.x.
  • AutoCAD: NOT present.
  • BricsCAD: NOT present.

Source Notes

  • clautolisp-only extension; the debugger surface is specified by the aldo debugger command reference. See this chapter's Overview for the CLAL-* probing convention.