IAgentCharacterEx::SetHelpFileName

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

HRESULT SetHelpFileName(
   BSTR bszName  // Help filename
);

Define o HelpFileName para um caractere.

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

bszName

O nome do arquivo da Ajuda para o caractere.

Se você tiver criado um arquivo de Ajuda do Windows para seu aplicativo e definido a propriedade HelpFile do caractere, o Microsoft Agent chamará automaticamente a Ajuda quando HelpModeOn estiver definido como True e o usuário clicar no caractere ou selecionar um comando em seu 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 da 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.

Nota

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

 

Consulte Também

IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::GetHelpFileName