Função MLHtmlHelp

[Essa função está disponível por meio do Windows XP e do Windows Server 2003. Ele pode estar alterado ou indisponível em versões subsequentes do Windows.]

Exibe uma janela de ajuda que corresponde à configuração atual do idioma da interface do usuário.

Sintaxe

HWND MLHtmlHelp(
  _In_ HWND      hwndCaller,
  _In_ LPCTSTR   pszFile,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData,
  _In_ DWORD     dwCrossCodePage
);

Parâmetros

hwndCaller [in]

Digite: HWND

Um identificador para a janela pai que chama essa função.

pszFile [in]

Tipo: LPCTSTR

Um ponteiro para um buffer que contém o caminho totalmente qualificado de um arquivo de ajuda compilado (.chm) ou um arquivo de tópico em um arquivo de ajuda especificado.

uCommand [in]

Tipo: UINT

O comando a ser concluído. Essa função dá suporte diretamente apenas a HH_DISPLAY_TOPIC e HH_DISPLAY_TEXT_POPUP. No caso de qualquer outro comando, a chamada é encaminhada sem o valor dwCrossCodePage para HtmlHelp.

dwData [in]

Tipo: DWORD_PTR

Todos os dados que podem ser necessários, com base no valor do parâmetro uCommand .

dwCrossCodePage [in]

Tipo: DWORD

O valor DWORD que indica a página de código da configuração atual do idioma da interface do usuário, como CP_ACP.

Valor retornado

Digite: HWND

Dependendo do uCommand especificado e do resultado, MLHtmlHelp 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

Se surgir um problema com o caminho do arquivo de ajuda para o idioma atual, a chamada será encaminhada para HtmlHelp para tratamento padrão.

Quando a janela de ajuda é fechada, o foco retorna ao 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 será retornado.

Além disso, se MLHtmlHelp enviar mensagens de notificação da janela de ajuda, as mensagens serão enviadas para hwndCaller , desde que você tenha habilitado o rastreamento de mensagens de notificação na definição da janela de ajuda.

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. Em geral, 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,
                     CP_ACP);

Observação

Ao usar essa função, 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 operação poderá falhar. Opcionalmente, você pode remover /STACK da linha de comando do link e também remover qualquer configuração STACK no arquivo DEF do executável (o tamanho da pilha padrão é 1 MB 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).

 

Requisitos

Requisito Valor
Cliente mínimo com suporte
Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte
Windows Server 2003 [somente aplicativos da área de trabalho]
Cabeçalho
Nenhum
DLL
Shlwapi.dll (versão 5.0 ou posterior)
Nomes Unicode e ANSI
MLHtmlHelpW (Unicode) e MLHtmlHelpA (ANSI)