Compartir a través de

estructura HH_AKLINK (htmlhelp.h)

Use esta estructura para especificar uno o varios nombres de ALink o palabras clave KLink que desea buscar.

Sintaxis

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

Miembros

cbStruct

Especifica el tamaño de la estructura. Este valor siempre debe rellenarse antes de pasar la estructura a la API de ayuda HTML.

fReserved

Este parámetro debe establecerse en FALSE.

pszKeywords

Especifica uno o varios nombres de ALink o palabras clave de KLink que se van a buscar. Varias entradas están delimitadas por un punto y coma.

pszUrl

Especifica el archivo de tema al que navegar si se produce un error en la búsqueda. pszURL hace referencia a un tema válido dentro del archivo de ayuda compilada (.chm) especificado y no admite protocolos de Internet que apuntan a un archivo HTML.

pszMsgText

Especifica el texto que se va a mostrar en un cuadro de mensaje si se produce un error en la búsqueda y fIndexOnFail es FALSE y pszURL es NULL.

pszMsgTitle

Especifica el subtítulo del cuadro de mensaje en el que aparece el parámetro pszMsgText.

pszWindow

Especifica el nombre del tipo de ventana en el que se va a mostrar una de las siguientes opciones:

  • El tema seleccionado, si la búsqueda produce uno o varios temas coincidentes.
  • El tema especificado en pszURL, si se produce un error en la búsqueda y se especifica un tema en pszURL.
La pestaña Índice, si se produce un error en la búsqueda y fIndexOnFail se especifica como TRUE.

fIndexOnFail

Especifica si se debe mostrar la palabra clave en la pestaña Índice del Visor de ayuda HTML si se produce un error en la búsqueda. El valor de pszWindow especifica el Visor de Ayuda.

Comentarios

  • Los nombres ALink y las búsquedas de palabras clave KLink distinguen mayúsculas de minúsculas y varias palabras clave están delimitadas por un punto y coma.
  • Si la búsqueda produce uno o varios temas coincidentes, los títulos del tema aparecen en el cuadro de diálogo Temas encontrados.
Si la búsqueda no produce temas coincidentes, HtmlHelp() comprueba los valores de los siguientes miembros HH_AKLINK para determinar qué acción alternativa realizar:
  • fIndexOnFail. Si fIndexOnFail es TRUE, la pestaña Índice se selecciona en la ventana de ayuda especificada en pszWindow y la palabra clave especificada en pszKeyword se selecciona en el campo de entrada.
  • pszURL. Si fIndexOnFail es FALSE, el archivo de tema especificado en pszURL aparece en la ventana de ayuda especificada en pszWindow.
  • pszMsgText y pszMsgTitle. Si fIndexOnFail es FALSE y pszURL es NULL, aparece un cuadro de mensaje con el texto y subtítulo especificado en pszMsgText y pszMsgTitle.

Usado por

Requisitos

Requisito Valor
Header htmlhelp.h

Consulte también

Acerca de las estructuras

  • Last updated on