Função HtmlHelpA (htmlhelp.h)
Exibe uma janela de ajuda.
Usando os comandos de API, você pode especificar qual tópico exibir na janela de ajuda, se a janela de ajuda é um Visualizador de Ajuda de três painéis ou uma janela pop-up e se o arquivo de tópico HTML deve ser acessado por meio de uma ID de contexto, uma URL de Ajuda HTML ou uma pesquisa de link de palavra-chave (KLink).
Sintaxe
HWND HtmlHelpA(
[in, optional] HWND hwndCaller,
[in] LPCSTR pszFile,
[in] UINT uCommand,
[in] DWORD_PTR dwData
);
Parâmetros
[in, optional] hwndCaller
Especifica o identificador (hwnd) da janela que chama HtmlHelp. A janela de ajuda pertence a essa janela.
Quando a janela de ajuda for fechada, HtmlHelp retornará o foco para o proprietário, a menos que o proprietário seja a área de trabalho. Se hwndCaller for a área de trabalho, o sistema operacional determinará onde o foco é retornado.
Além disso, se HtmlHelp enviar mensagens de notificação da janela de ajuda, elas serão enviadas para hwndCaller desde que você tenha habilitado o rastreamento de mensagens de notificação na definição da janela de ajuda.
[in] pszFile
Dependendo do valor uCommand , especifica o caminho do arquivo para um arquivo de ajuda compilado (.chm) ou um arquivo de tópico em um arquivo de ajuda especificado.
Um nome de tipo de janela também pode ser especificado, precedido por um caractere maior que (>).
Se o comando especificado não exigir um arquivo, esse valor poderá ser NULL.
[in] uCommand
Especifica o comando a ser concluído.
[in] dwData
Especifica todos os dados que podem ser necessários, com base no valor do parâmetro uCommand .
Retornar valor
Dependendo do uCommand especificado e do resultado, HtmlHelp retorna um ou ambos os seguintes:
- O identificador (hwnd) da janela de ajuda.
NULL. Em alguns casos, NULL indica falha; em outros casos, NULL indica que a janela de ajuda ainda não foi criada.
Comentários
A sintaxe se aplica a conjuntos de caracteres ANSI. Ao usar um conjunto de caracteres Unicode, o tipo do parâmetro pszFile deve ser "LPCTSTR".
Ao usar a API de Ajuda HTML, defina o tamanho da pilha do executável de hospedagem como pelo menos 100 mil. Se o tamanho da pilha definido for muito pequeno, o thread criado para executar a Ajuda HTML também será criado com esse tamanho de pilha e a falha poderá resultar. Opcionalmente, você pode remover /STACK da linha de comando do link e remover qualquer configuração STACK no arquivo DEF do executável (o tamanho da pilha padrão é 1MB nesse caso). Você também pode definir o tamanho da pilha usando o comando do compilador /Fnumber (o compilador passará isso para o vinculador como /STACK).
Exemplos
O exemplo a seguir chama o comando HH_DISPLAY_TOPIC para abrir o arquivo de ajuda chamado Help.chm e exibir seu tópico padrão na janela de ajuda chamada Mainwin. Geralmente, a janela de ajuda especificada neste comando é um Visualizador de Ajuda HTML padrão.
HWND hwnd =
HtmlHelp(
GetDesktopWindow(),
"c:\\Help.chm::/Intro.htm>Mainwin",
HH_DISPLAY_TOPIC,
NULL) ;
Observação
O cabeçalho htmlhelp.h define HtmlHelp como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
| Requisito | Valor |
|---|---|
| Plataforma de Destino | Windows |
| Cabeçalho | htmlhelp.h |
| Biblioteca | Htmlhelp.lib |
| DLL | hhctrl.ocx |