Function Entry: SETFUNHELP

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

Function Entry: SETFUNHELP

Name

setfunhelp

Class

Function

Syntax

(setfunhelp c:fname [helpfile [topic [command]]])

Arguments and Values

  • c:fname: string; the user-defined command name. Must include the c: prefix.
  • helpfile (optional): string; help file name. Extension is optional; AutoCAD looks for .chm first, then .hlp.
  • topic (optional): string; help topic identifier. For CHM files, supply the topic file name without extension.
  • command (optional): string; initial Help-window state expressed as an HtmlHelp() or WinHelp() command (e.g. `HHDISPLAYTOPIC`).

Description

Registers a user-defined command so the Help facility opens the supplied file and topic when the user requests help on that command. Calling defun to redefine the same command name removes its setfunhelp registration; therefore call setfunhelp after defun.

Return Values

Returns the c:fname string on success, otherwise nil. The function only validates the c: prefix; it does not verify that the function or topic exists.

Side Effects

Updates the Help-binding registry for the named command.

Examples

  • After `(defun c:test () (getstring "

TEST: ") (princ)), (setfunhelp "c:test" "acadacr.chm" "line") associates the LINE help topic with c:test`.

Availability

  • AutoCAD 2026: documented (Windows-centric — CHM/HLP).
  • BricsCAD V26: presumed compatible (BricsCAD has its own help system; binding semantics may differ).
  • Status: AutoCAD documented; BricsCAD presumed-both pending Phase 4 verification.

Source Notes