HH_AKLINK構造体 (htmlhelp.h)

この構造体を使用して、検索する 1 つ以上の ALink 名または KLink キーワードを指定します。

構文

typedef struct tagHH_AKLINK {
  int     cbStruct;
  BOOL    fReserved;
  LPCTSTR pszKeywords;
  LPCTSTR pszUrl;
  LPCTSTR pszMsgText;
  LPCTSTR pszMsgTitle;
  LPCTSTR pszWindow;
  BOOL    fIndexOnFail;
} HH_AKLINK;

メンバー

cbStruct

構造体のサイズを指定します。 構造体を HTML ヘルプ API に渡す前に、常にこの値を入力する必要があります。

fReserved

このパラメーターは FALSE に設定する必要があります。

pszKeywords

検索する 1 つ以上の ALink 名または KLink キーワードを指定します。 複数のエントリはセミコロンで区切られます。

pszUrl

参照が失敗した場合に移動するトピック ファイルを指定します。 pszURL は、指定されたコンパイル済みヘルプ (.chm) ファイル内の 有効なトピック を参照し、HTML ファイルを指すインターネット プロトコルをサポートしていません。

pszMsgText

検索が失敗し、 fIndexOnFail が FALSE で pszURL が NULL の場合に、メッセージ ボックスに表示するテキストを指定します。

pszMsgTitle

pszMsgText パラメーターが表示されるメッセージ ボックスのキャプションを指定します。

pszWindow

次のいずれかを表示するウィンドウの種類の名前を指定します。

  • 検索によって 1 つ以上の一致するトピックが生成される場合は、選択したトピック。
  • 検索が失敗し、 pszURL でトピックが指定されている場合、 pszURL で指定されたトピック。
ルックアップが失敗し、 fIndexOnFail が TRUE として指定されている場合は、[インデックス] タブ。

fIndexOnFail

検索が失敗した場合に HTML ヘルプ ビューアーの [インデックス] タブにキーワード (keyword)を表示するかどうかを指定します。 pszWindow の値は、ヘルプ ビューアーを指定します。

注釈

  • ALink 名と KLink キーワード (keyword)参照では大文字と小文字が区別され、複数のキーワードはセミコロンで区切られます。
  • ルックアップによって一致するトピックが 1 つ以上生成される場合、トピックタイトルは [トピックが見つかりました] ダイアログ ボックスに表示されます。
ルックアップで一致するトピックが生成されない場合、 HtmlHelp() は次の HH_AKLINK メンバーの値をチェックして、実行する代替アクションを決定します。
  • fIndexOnFail。 fIndexOnFail が TRUE の場合、pszWindow で指定されたヘルプ ウィンドウで [インデックス] タブが選択され、pszKeyword で指定されたキーワード (keyword)がエントリ フィールドで選択されます。
  • pszURL。 fIndexOnFail が FALSE の場合、pszURL で指定されたトピック ファイルが pszWindow で指定されたヘルプ ウィンドウに表示されます。
  • pszMsgText と pszMsgTitle。 fIndexOnFail が FALSE で、pszURL が NULL の場合は、テキストを使用してメッセージ ボックスが表示され、pszMsgText と pszMsgTitle で指定キャプション。

使用者

要件

要件 値
Header htmlhelp.h

こちらもご覧ください

構造体について

  • Last updated on