Função WinHelpA (winuser.h)
Inicia a Ajuda do Windows (Winhelp.exe) e passa dados adicionais que indicam a natureza da ajuda solicitada pelo aplicativo.
Sintaxe
BOOL WinHelpA(
HWND hWndMain,
LPCSTR lpszHelp,
UINT uCommand,
ULONG_PTR dwData
);
Parâmetros
hWndMain
Digite: HWND
Um identificador para a janela solicitando ajuda. A função WinHelp usa esse identificador para acompanhar quais aplicativos solicitaram ajuda. Se o parâmetro uCommandespecificar HELP_CONTEXTMENU ou HELP_WM_HELP, hWndMain identificará o controle que solicita ajuda.
lpszHelp
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 WinHelp deve exibir.
O nome do arquivo pode ser seguido por um colchete angular (>) e o nome de uma janela secundária se o tópico for exibido em uma janela secundária e não na janela primária. Você deve definir o nome da janela secundária na seção [WINDOWS] do arquivo de projeto de Ajuda (.hpj).
uCommand
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âmetro dwData , consulte a seção Comentários.
dwData
Tipo: ULONG_PTR
Dados adicionais. O valor usado depende do valor do parâmetro uCommand . Para obter uma lista de possíveis valores dwData , consulte a seção Comentários.
Retornar valor
Tipo: BOOL
Retorna diferente de zero se tiver êxito; caso contrário, zero. Para recuperar informações de erro estendidas, chame GetLastError.
Comentários
Antes de fechar a janela que solicitou ajuda, o aplicativo deve chamar WinHelp 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.
Essa função falhará se for chamada de qualquer contexto, mas o usuário atual.
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 cadeia de caracteres de macro. | Endereço de uma cadeia de caracteres que especifica o nome das macros da 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 curta do nome da macro para algumas macros porque a Ajuda do Windows não dá suporte ao nome longo. |
| HELP_CONTENTS | Exibe o tópico especificado pela opção Conteúdo na seção [OPÇÕES] do arquivo .hpj. Esse 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 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 encerrada 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 de um tópico. |
| HELP_FINDER | Exibe a caixa de diálogo Tópicos da 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á a correta; caso contrário, não há nenhuma 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 [OPÇÕES] do arquivo .hpj. Esse 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 palavra-chave que corresponde ao palavra-chave especificado, 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 um 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 um palavra-chave. |
| HELP_PARTIALKEY | Exibe o tópico na tabela palavra-chave que corresponde ao palavra-chave especificado, 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 um 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 MAKELONG para concatenar as coordenadas horizontais e verticais 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 ela 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 primária ou secundária. |
| HELP_TCARD | Indica que um comando é para um treinamento cartão instância 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 para um tópico. A matriz deve ser encerrada 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. |
Observação
O cabeçalho winuser.h define WinHelp 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 |
|---|---|
| Cliente mínimo com suporte | Windows XP [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | winuser.h |
| Biblioteca | User32.lib |
| DLL | User32.dll |
| Conjunto de APIs | ext-ms-win-ntuser-misc-l1-5-1 (introduzido no Windows 10, versão 10.0.14393) |