Compartilhar via

estrutura HH_AKLINK (htmlhelp.h)

Use essa estrutura para especificar um ou mais nomes ALink ou palavras-chave KLink que você deseja pesquisar.

Sintaxe

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

Membros

cbStruct

Especifica o tamanho da estrutura. Esse valor sempre deve ser preenchido antes de passar a estrutura para a API de Ajuda HTML.

fReserved

Esse parâmetro deve ser definido como FALSE.

pszKeywords

Especifica um ou mais nomes ALink ou palavras-chave KLink para pesquisar. Várias entradas são delimitadas por ponto e vírgula.

pszUrl

Especifica o arquivo de tópico para o qual navegar se a pesquisa falhar. pszURL refere-se a um tópico válido dentro do arquivo de ajuda (.chm) compilado especificado e não dá suporte a protocolos de Internet que apontam para um arquivo HTML.

pszMsgText

Especifica o texto a ser exibido em uma caixa de mensagem se a pesquisa falhar e fIndexOnFail for FALSE e pszURL for NULL.

pszMsgTitle

Especifica o legenda da caixa de mensagem na qual o parâmetro pszMsgText é exibido.

pszWindow

Especifica o nome do tipo de janela no qual exibir um dos seguintes:

  • O tópico selecionado, se a pesquisa produzir um ou mais tópicos correspondentes.
  • O tópico especificado em pszURL, se a pesquisa falhar e um tópico for especificado em pszURL.
A guia Índice, se a pesquisa falhar e fIndexOnFail for especificada como TRUE.

fIndexOnFail

Especifica se o palavra-chave será exibido na guia Índice do Visualizador de Ajuda HTML se a pesquisa falhar. O valor de pszWindow especifica o Help Viewer.

Comentários

  • O nome ALink e as pesquisas de palavra-chave KLink diferenciam maiúsculas de minúsculas e várias palavras-chave são delimitadas por ponto e vírgula.
  • Se a pesquisa produzir um ou mais tópicos correspondentes, os títulos do tópico aparecerão na caixa de diálogo Tópicos Encontrados.
Se a pesquisa não produzir tópicos correspondentes, HtmlHelp() verificará os valores dos seguintes membros HH_AKLINK para determinar qual ação alternativa deve ser tomada:
  • fIndexOnFail. Se fIndexOnFail for TRUE, a guia Índice será selecionada na janela de ajuda especificada em pszWindow e o palavra-chave especificado em pszKeyword será selecionado no campo de entrada.
  • pszURL. Se fIndexOnFail for FALSE, o arquivo de tópico especificado em pszURL aparecerá na janela de ajuda especificada em pszWindow.
  • pszMsgText e pszMsgTitle. Se fIndexOnFail for FALSE e pszURL for NULL, uma caixa de mensagem será exibida usando o texto e legenda especificados em pszMsgText e pszMsgTitle.

Usado por

Requisitos

Requisito Valor
Cabeçalho htmlhelp.h

Confira também

Sobre estruturas

  • Last updated on