WinHelp

概要: baWinHelpはWindowsのヘルプファイルを表示します。

シンタックス: Result = baWinHelp(Cmd, HelpFile, Data )

パラメータ: #string, #string, #string
Cmd ヘルプファイルのコマンド。下記のいずれかになります。
 "Contents" コンテンツページを表示します。
 "Context" "Data"で指定したコンテキスト番号を持つページを表示します。
 "PopUp" "Data"で指定したコンテキスト番号を持つページをポップアップウィンドウで表示します。
 "Show" "Data"で指定したトピックと一致するものが一つ見つかった場合に、そのトピックを表示します。一致するものが2つ以上あった場合は検索ダイアログボックスを表示します。一致するものが無かった場合は、エラーメッセージが表示されます。(訳者注:Win2000での検証では"Search"と同じです。)
 "Search" "Data"で指定したトピックと一致するものが一つ見つかった場合に、そのトピックを表示します。一致するものが2つ以上あった場合は検索ダイアログボックスを表示します。一致するものが無かった場合も検索ダイアログボックスを表示します。
 "Quit" ヘルプファイルを閉じます。
 "Help" ヘルプファイルのヘルプページを表示します。
 "Macro" "Data"で指定した名前のマクロを実行します。

HelpFile 表示するヘルプファイルの名前。ヘルプファイルまでの完全なパスを指定してください。
Data 追加情報を持つストリング。使用するCmdによってさまざまな値をとります。番号が必要な場合でもストリングとして渡さなければならないことに注意してください。
 "Contents"  Dataは""を指定してください。
 "Context" Dataはコンテキスト番号です。例:"4"。
 "PopUp" Dataはコンテキスト番号です。例:"4"。
 "Show" Dataは表示するトピックのストリングです。例:"About BudAPI"。
 "Search" Dataは検索するトピックのストリングです。例:"About BudAPI"。
 "Quit" Dataは""を指定してください。
 "Help" Dataは""を指定してください。
 "Macro" Dataは実行するマクロの名前です。例:"PlayMovie"。

戻り値:

#integer
成功した場合は1を、それ以外は0を返します。ヘルプファイルが見つからなくても不成功とはみなされません。

例: OK = WinHelp( "Show", the pathName & "myhelp.hlp", "Flowers" )
OK = WinHelp( "Quit", the pathName & "myhelp.hlp", "" )