help

调用帮助工具

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

参数

helpfile

指定帮助文件的字符串。helpfile 参数不需要指定文件扩展名。如果指定文件扩展名，则 AutoCAD 仅查找该文件。

如果 helpfile 参数为空字符串 ("") 或被省略，则 AutoCAD 使用缺省 AutoCAD 帮助文件。

如果不指定扩展名，则 AutoCAD 查找带 .chm 扩展名的 helpfile，如果找不到该名称的文件，AutoCAD 查找带 .hlp 扩展名的文件。

topic

关键字，指定帮助显示的主题 ID。如果 topic 参数是空字符串 ("")，则会显示帮助文件的默认页面。如果在调用 CHM 文件中的主题，提供的文件名不需要扩展名， AutoCAD 会自动添加 .htm扩展名。

command

字符串，指定帮助窗口的初始状态，command 参数是 HtmlHelp() 和 WinHelp() 函数的 uCommand(在 HTML 帮助中)或 fucommand(在 WinHelp 中)参数所使用的一个字符串，HtmlHelp() 和 WinHelp() 函数的定义可参见 Microsoft Windows SDK 中的 WinHelp API。

对于 HTML 帮助文件，command 参数可以是 HH_ALINK_LOOKUP 或 HH_DISPLAY_TOPIC 值，对于 Windows 帮助文件，command 可以是 HELP_CONTENTS, HELP_HELPONHELP, 或 HELP_PARTIALKEY。

HH_ALINK_LOOKUP 显示帮助文件的“索引”项。

HH_DISPLAY_TOPIC 显示帮助文件的“目录”项。

HELP_CONTENTS 显示帮助文件的第一个主题。

HELP_HELPONHELP 显示“如何使用帮助”的帮助。

HELP_PARTIALKEY 显示搜索对话框，将传送的字符串作为初始搜索文本。

返回值

如果调用成功则返回 helpfile 字符串，否则返回 nil。如果不带参数调用 help，则在成功时返回空字符串 ("")，不成功时返回 nil。
help 函数返回给应用程序的唯一错误条件是由参数 helpfile 指定的文件不存在。所有其他的错误条件都通过对话框报告用户。

示例

下列代码调用 help 显示 achelp.hlp 中 MYCOMMAND 主题的信息：

(help "achelp.chm" "mycommand")

参阅

setfunhelp 函数用于将上下文相关帮助函数（用户按 F1 时得到的帮助）与用户自定义命令关联起来。