Function Entry: CLAL-INVOKE-DEBUGGER

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

Function Entry: CLAL-INVOKE-DEBUGGER

Name

clal-invoke-debugger

Class

clautolisp Extension Function

Syntax

(clal-invoke-debugger [message])

Arguments and Values

  • message — optional; a message shown at the stop (typically a string). Omitted for a plain break.

Description

Like clal-break, but display message when the debugger stops (debugger command reference §1). It funcalls the runtime's debug-break hook with message. A no-op when no debug session is active (the hook is unbound).

Return Values

Always nil.

Side Effects

When a debug session is active, stops in the aldo debugger showing message; otherwise none.

Affected By

  • Whether a debug session (aldo) is currently active.

Exceptional Situations

None.

Examples

(if (< bal 0)
    (clal-invoke-debugger "negative balance"))
=> nil

Availability

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

Source Notes

  • clautolisp-only extension; see this chapter's Overview for the rationale and probing convention.