Help

提供: GizmoLabs
移動先: 案内検索
構文
(help [helpfile [topic [command]]])


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


引数
  • helpfile … ヘルプ ファイルの名前を示す文字列。 helpfile 引数では、ファイル拡張子は必要ない。ファイル拡張子を指定すると、指定した名前のファイルのみが検索される。ファイル拡張子を指定しないと、CAD は拡張子 .chm の helpfile 引数のファイルを探す。その名前のファイルが見つからない場合、CAD は拡張子 .hlp のファイルを探す。
  • topic … ヘルプ トピック ID を指定する文字列。拡張子を付けずに CHM ファイル内のトピックを呼び出すと、CAD は拡張子 .htm を追加する。
  • command … [ヘルプ]ウィンドウの初期状態を指定する文字列。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 を指定することができる。


戻り値
成功した場合は helpfile 文字列、それ以外の場合は nil。引数を指定せずに help 関数を使用すると、正常に終了した場合は空の文字列("")を、失敗した場合は nil が返される。
  • help 関数がアプリケーションに返す唯一のエラー状態は、helpfile 引数で指定したファイルの存在状態。他のすべてのエラーは、ダイアログ ボックスを通してユーザに報告される。


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

(help "achelp.chm" "mycommand" "HH_DISPLAY_TOPIC")

(help "achelp.chm" "mycommand" "HH_ALINK_LOOKUP")

関連事項