help (AutoLISP)

ヘルプ機能を呼び出します。

サポートされているプラットフォーム: Windows のみ

構文と要素

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

helpfile

タイプ: 文字列

ヘルプ ファイルの名前。helpfile 引数では、ファイル拡張子は必要ありません。ファイル拡張子を指定した場合、指定した名前のファイルのみが検索されます。

ファイル拡張子を指定しなかった場合、helpfile 引数で渡されたファイル名と拡張子 .chm を組み合わせた名前のファイルが検索されます。その名前のファイルが見つからなかった場合、今度は拡張子 .hlp のファイルが検索されます。

topic

タイプ: 文字列

ヘルプ トピック ID。

CHM ファイル内のトピックの呼び出しで、拡張子を指定せずファイル名だけを渡した場合、拡張子 .htm が追加されます。

command (Windows のみ)

タイプ: 文字列

[ヘルプ]ウィンドウの初期状態を指定します。command 引数を、Microsoft Windows SDK で定義されている HtmlHelp()関数および WinHelp()関数の uCommand(HTML ヘルプ)または fuCommand(WinHelp)引数で使用される文字列にすることもできます。

HTML ファイルでは、command 引数に、HH_ALINK_LOOKUP または HH_DISPLAY_TOPIC を指定することができます。Windows ヘルプ ファイルでは、HELP_CONTENTS、HELP_HELPONHELP、HELP_PARTIALKEY を指定することができます。 

戻り値

タイプ: 文字列または nil

成功した場合は helpfile 文字列、それ以外の場合は nil。引数を指定せずに help 関数を使用すると、正常に終了した場合は空の文字列("")を、失敗した場合は nil が返されます。

help 関数がアプリケーションに返す唯一のエラー状態は、helpfile 引数で指定したファイルの存在状態です。他のすべてのエラーは、ダイアログ ボックスを通してユーザに報告されます。

例

次のコードは、help 関数を呼び出して achelp.chm ヘルプ ファイル内の MYCOMMAND の情報を表示します。

(help "achelp.chm" "mycommand")