Function Entry: HELP

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

Function Entry: HELP

Name

help

Class

Function

Syntax

(help [helpfile [topic [command]]])

Arguments and Values

  • helpfile (optional): string; help-file name. Extension is optional; AutoCAD looks for .chm first, then .hlp. An empty string opens the online help.
  • topic (optional): string; topic identifier. For CHM files, supply the topic file name without extension.
  • command (optional, Windows only): string; initial Help-window state expressed as an HtmlHelp() / WinHelp() argument.

Description

Invokes the Help facility. Place help files in a folder whose path contains no Unicode characters; the Microsoft HTML Help executable is sensitive to that.

Return Values

Returns the helpfile string on success, otherwise nil. With no arguments, returns the empty string "" on success or nil on failure.

Side Effects

Opens a help window or browser tab.

Examples

  • (help "achelp.chm" "mycommand") opens the topic for MYCOMMAND in achelp.chm.

Availability

  • AutoCAD 2026: documented (Windows, macOS, Web).
  • BricsCAD V26: presumed compatible (BricsCAD has a HELP command).
  • Status: AutoCAD documented; BricsCAD presumed-both pending Phase 4 verification.