Função MLWinHelp

[Esta função está disponível no Windows XP e Windows Server 2003. Ela pode estar indisponível ou ter sido alterada em versões subsequentes do Windows.]

Inicia a Ajuda do Windows (Winhelp.exe) e passa dados adicionais que indicam a natureza da ajuda solicitada pelo aplicativo.

Sintaxe

BOOL MLWinHelp(
  _In_ HWND      hWndMain,
  _In_ LPCTSTR   lpszHelp,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData
);

Parâmetros

hWndMain [entrada]

Digite: HWND

Um identificador para a janela solicitando ajuda. A função MLWinHelp usa esse identificador para controlar quais aplicativos solicitaram ajuda. Se o parâmetro uCommand especificar HELP_CONTEXTMENU ou HELP_WM_HELP, hWndMain identificará o controle solicitando ajuda.

lpszHelp [entrada]

Tipo: LPCTSTR

O endereço de uma cadeia de caracteres terminada em nulo que contém o caminho, se necessário, e o nome do arquivo de ajuda que MLWinHelp vai exibir.

O nome do arquivo pode ser seguido por um parêntese angular (>) e o nome de uma janela secundária se o tópico for exibido em uma janela secundária em vez de na janela principal. Você deve definir o nome da janela secundária na seção [WINDOWS] do arquivo de projeto de ajuda (.hpj).

uCommand [entrada]

Tipo: UINT

O tipo de ajuda solicitada. Para obter uma lista de valores possíveis e como eles afetam o valor a ser colocado no parâmetrodwData, consulte a seção Observações.

dwData [entrada]

Tipo: DWORD_PTR

Dados adicionais. O valor usado depende do valor do parâmetro uCommand. Consulte a seção Observações para obter a lista de valores possíveis de dwData.

Valor retornado

Tipo: BOOL

Retorna um valor diferente de zero em caso de sucesso ou zero caso contrário. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Essa função não está incluída em um arquivo de cabeçalho e deve ser chamada pelo ordinal 395 para MLWinHelpA e 397 para MLWinHelpW.

MLWinHelp é essencialmente um encapsulador de WinHelp. Ele tenta obter o caminho para o arquivo de ajuda correspondente à configuração de idioma da interface do usuário atual antes de chamar WinHelp. Se ele conseguir, ele passa por esse caminho. Se ele falhar, ele passa o caminho apontado por lpszHelp.

Essa função falhará se chamada de qualquer contexto, exceto do usuário atual.

Antes de fechar a janela que solicitou ajuda, o aplicativo deve chamar MLWinHelp com o parâmetro uCommand definido como HELP_QUIT. Até que todos os aplicativos tenham feito isso, a Ajuda do Windows não será encerrada. Observe que chamar a Ajuda do Windows com o comando HELP_QUIT não é necessário se você usou o comando HELP_CONTEXTPOPUP para iniciar a Ajuda do Windows.

A tabela a seguir mostra os valores possíveis para o parâmetro uCommand e os formatos correspondentes do parâmetro dwData.

uCommand Ação dwData
HELP_COMMAND Executa uma macro de ajuda ou uma cadeia de caracteres de macro. Endereço de uma cadeia de caracteres que especifica o nome de macros de ajuda a serem executadas. Se a cadeia de caracteres especificar vários nomes de macro, os nomes deverão ser separados por ponto-e-vírgula. Você deve usar a forma abreviada do nome da macro para algumas macros porque a Ajuda do Windows não oferece suporte ao nome longo.
HELP_CONTENTS Exibe o tópico especificado pela opção Conteúdo na seção [OPTIONS] do arquivo .hpj. Este comando é para compatibilidade com versões anteriores. Novos aplicativos devem fornecer um arquivo .cnt e usar o comando HELP_FINDER. Ignorado; definido como 0.
HELP_CONTEXT Exibe o tópico identificado pelo identificador de contexto especificado definido na seção [MAP] do arquivo .hpj. Contém o identificador de contexto do tópico.
HELP_CONTEXTMENU Exibe o menu Ajuda da janela selecionada e, em seguida, exibe o tópico do controle selecionado em uma janela pop-up. Endereço de uma matriz de pares DWORD. O primeiro DWORD em cada par é o identificador de controle e o segundo é o identificador de contexto do tópico. A matriz deve ser terminada por um par de zeros {0,0}. Se você não quiser adicionar ajuda a um controle específico, defina seu identificador de contexto como -1.
HELP_CONTEXTPOPUP Exibe o tópico identificado pelo identificador de contexto especificado definido na seção [MAP] do arquivo .hpj em uma janela pop-up. Contém o identificador de contexto do tópico.
HELP_FINDER Exibe a caixa de diálogo Tópicos de Ajuda. Ignorado; definido como 0.
HELP_FORCEFILE Garante que a Ajuda do Windows esteja exibindo o arquivo de ajuda correto. Se o arquivo de ajuda incorreto estiver sendo exibido, a Ajuda do Windows abrirá o arquivo correto; caso contrário, não haverá ação. Ignorado; definido como 0.
HELP_HELPONHELP Exibe ajuda sobre como usar a Ajuda do Windows, se o arquivo Winhlp32.hlp estiver disponível. Ignorado; definido como 0.
HELP_INDEX Exibe o tópico especificado pela opção Conteúdo na seção [OPTIONS] do arquivo .hpj. Este comando é para compatibilidade com versões anteriores. Novos aplicativos devem usar o comando HELP_FINDER. Ignorado; definido como 0.
HELP_KEY Exibe o tópico na tabela de palavras-chave que corresponde à palavra-chave especificada, se houver uma correspondência exata. Se houver mais de uma correspondência, exibirá o índice com os tópicos listados na caixa de listagem Tópicos Encontrados. Endereço de uma cadeia de caracteres de palavra-chave. Várias palavras-chave devem ser separadas por ponto e vírgula.
HELP_MULTIKEY Exibe o tópico especificado por uma palavra-chave em uma tabela de palavra-chave alternativa. Endereço de uma estrutura MULTIKEYHELP que especifica um caractere de nota de rodapé de tabela e uma palavra-chave.
HELP_PARTIALKEY Exibe o tópico na tabela de palavras-chave que corresponde à palavra-chave especificada, se houver uma correspondência exata. Se houver mais de uma correspondência, exibirá a caixa de diálogo Tópicos Encontrados. Para exibir o índice sem passar uma palavra-chave, use um ponteiro para uma cadeia de caracteres vazia. Endereço de uma cadeia de caracteres de palavra-chave. Várias palavras-chave devem ser separadas por ponto e vírgula.
HELP_QUIT Informa à Ajuda do Windows que ela não é mais necessária. Se nenhum outro aplicativo tiver solicitado ajuda, o Windows fechará a Ajuda do Windows. Ignorado; definido como 0.
HELP_SETCONTENTS Especifica o tópico Conteúdo. A Ajuda do Windows exibirá este tópico quando o usuário clicar no botão Conteúdo se o arquivo de ajuda não tiver um arquivo .cnt associado. Contém o identificador de contexto do tópico Conteúdo.
HELP_SETPOPUP_POS Define a posição da janela pop-up subsequente. Contém os dados de posição. Use a macro MAKELONG para concatenar as coordenadas horizontal e vertical em um único valor. A janela pop-up é posicionada como se o cursor do mouse estivesse no ponto especificado quando a janela pop-up foi invocada.
HELP_SETWINPOS Exibe a janela da Ajuda do Windows, se estiver minimizada ou na memória, e define seu tamanho e posição conforme especificado. Endereço de uma estrutura HELPWININFO que especifica o tamanho e a posição de uma janela de ajuda principal ou secundária.
HELP_TCARD Indica que um comando é para uma instância de cartão de treinamento da Ajuda do Windows. Combine esse comando com outros comandos usando o operador OR bit a bit. Depende do comando com o qual esse comando é combinado.
HELP_WM_HELP Exibe o tópico do controle identificado pelo parâmetro hWndMain em uma janela pop-up. Endereço de uma matriz de pares DWORD. O primeiro DWORD em cada par é um identificador de controle e o segundo é um identificador de contexto de um tópico. A matriz deve ser terminada por um par de zeros {0,0}. Se você não quiser adicionar Ajuda a um controle específico, defina seu identificador de contexto como -1.

 

Requisitos

Requisito Valor
Cliente mínimo com suporte
Windows 2000 Professional, Windows XP [somente aplicativos de desktop]
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
MLWinHelpW (Unicode) e MLWinHelpA (ANSI)

Confira também

HELPWININFO

MULTIKEYHELP