パラメータ
hwndCaller
HtmlHelp() を呼び出すウィンドウのハンドル (hwnd) を指定する。このウィンドウがヘルプ
ウィンドウのオーナーになる。
ヘルプ ウィンドウを閉じると、HtmlHelp()
は、オーナーがデスクトップである場合を除いて、フォーカスをオーナーに戻す。
hwndCaller がデスクトップの場合は、オペレーティング システムによって、フォーカスを戻す場所が決定される。
さらに、ヘルプ ウィンドウの定義で通知メッセージのトラッキングをオンにしている場合、HtmlHelp() はヘルプ
ウィンドウからの通知メッセージ
をすべて hwndCaller に送信する。
pszFile
uCommand の値によって、コンパイル済みヘルプ (.chm) ファイル、またはコンパイル済みヘルプ
ファイル中のトピックファイルのどちらかのファ
イル パスを指定する。
不等号 (>) に続けてウィンドウ タイプ名を指定することもできる。
指定したコマンドがファイル名を必要としない場合は、この値は NULL になる。
uCommand
実行するコマンドを指定する。指定するコマンドの種類は次のとおり。
カテゴリ
|
値
|
意味
|
ウィンドウ タイプ |
HH_CLOSE_ALL |
呼び出しプログラムによって開かれたウィンドウをすべて閉じる。 |
|
HH_GET_WIN_HANDLE |
指定されたウィンドウ タイプのウィンドウ ハンドル (hwnd) を返す。 |
|
HH_GET_WIN_TYPE |
関連付けられた HH_WINTYPE 構造体へのポインタを取得する。 |
|
HH_SET_WIN_TYPE
|
ヘルプ実行時に、新しいヘルプウィンドウを作成、または既存のヘルプウィン
ドウを変更する。 |
状況依存のヘルプ
|
HH_DISPLAY_TEXT_POPUP
|
次のいずれかの内容が表示されているポップアップ ウィンドウを開く。
・明示的なテキスト文字列
・リソース ID に基づいたテキスト文字列
・コンパイル済みヘルプ (.chm) ファイル中のテキスト ファイルに基づいたテキス
ト文字列の
ID |
|
HH_DISPLAY_TOPIC |
指定されたヘルプ ウィンドウでヘルプ トピックを開く。 |
|
HH_HELP_CONTEXT |
マップされたトピック ID に基づいてヘルプ トピックを表示する。 |
|
HH_TP_HELP_CONTEXTMENU |
ポップアップ コンテキスト メニューを開く。 |
|
HH_TP_HELP_WM_HELP |
ポップアップ ヘルプ トピックを開く。 |
キーワード検索
|
HH_ALINK_LOOKUP
|
コンパイル済みヘルプ (.chm) ファイルから、1 つまたは複数の関連リンク
(ALink) 名を検索する。
|
|
HH_KEYWORD_LOOKUP
|
コンパイル済みヘルプ (.chm) ファイルから、1 つまたは複数のキーワードを検
索する。
|
ナビゲーション ペイン
|
HH_DISPLAY_INDEX
|
HTML Help Viewer のナビゲーション ペインの [キーワード] タブを選択し、
dwData パラメータで指定されたキーワードを検索する。
|
|
HH_DISPLAY_SEARCH |
HTML Help Viewer のナビゲーション ペインの [検索] タブを選択する。 |
|
HH_DISPLAY_TOC |
HTML Help Viewer のナビゲーション ペインの [目次] タブを選択する。 |
エラー メッセージ
|
HH_GET_LAST_ERROR
|
HTML Help ActiveX コントロール (Hhctrl.ocx) で発生した最新のエラーに
関する情報を返す。
|
目次の同期
|
HH_SYNC
|
Help Viewer のトピック ペインに開かれているヘルプ トピックの目次項目を同
期して選択する。
|
シングル スレッド |
HH_INITIALIZE |
ヘルプ システムを初期化して使用可能な状態にする。 |
|
HH_PRETRANSLATEMESSAGE
|
シングル スレッドで HTML Help を実行しているときに、Windows メッセー
ジ
(特にキーボード メッセージ) を正しく処理するために、Windows アプリケー
ションのメッセージ ループ内で呼び出す。
|
|
HH_UNINITIALIZE |
HTML Help を正常に終了するために、このコマンドを呼び出する。 |
dwData
uCommand パラメータの値に基づいて、必要なデータを指定する。
戻り値
指定された uCommand とコマンドの実行結果に応じて、HtmlHelp() は次の値の 1 つまたは両方を返す。
・ヘルプ ウィンドウのハンドル (hwnd)
・NULL。NULL は、失敗を意味する場合もあれば、ヘルプ ウィンドウがまだ作成されていないことを示す場合もある。
|