Compartilhar via

IAgentCharacterEx::GetHelpFileName

  • Artigo

[O Microsoft Agent foi preterido a partir do Windows 7 e pode estar indisponível nas versões subsequentes do Windows.]

HRESULT GetHelpFileName(
   BSTR * pbszName  // address of Help filename
);

Recupera o HelpFileName de um caractere.

  • Retorna S_OK para indicar que a operação foi bem-sucedida.

pbszName

Endereço de uma variável que recebe o nome do arquivo da Ajuda para o caractere.

Se você tiver criado um arquivo da Ajuda do Windows para seu aplicativo e definir a propriedade HelpFile do caractere, o Microsoft Agent chamará a Ajuda automaticamente quando HelpModeOn estiver definido como True e o usuário clicar no caractere ou selecionar um comando no menu pop-up. Se houver um número de contexto na propriedade HelpContextID do comando selecionado, a Ajuda exibirá um tópico correspondente ao contexto de Ajuda atual; caso contrário, ele exibirá "Nenhum tópico de Ajuda associado a este item".

Essa propriedade se aplica somente ao uso do caractere pelo aplicativo cliente; a configuração não afeta outros clientes do caractere ou outros caracteres do aplicativo cliente.

Observação

A criação de um arquivo de Ajuda requer o Compilador de Ajuda do Microsoft Windows.

 

Consulte Também

IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName