Compartilhar via

IAgentCharacterEx::GetHelpContextID

  • Artigo

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of character's help topic ID
);

Recupera o HelpContextID para o caractere.

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

pulHelpID

Endereço de uma variável que recebe o número de contexto do tópico de ajuda para o caractere.

Se você tiver criado um arquivo de 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 selecionar o caractere. Se houver um número de contexto no HelpContextID, o Agent chamará a Ajuda e procurará o tópico identificado pelo número de contexto atual. O número de contexto atual é o valor de HelpContextID para o caractere.

IAgentCharacterEx::GetHelpContextID retorna o HelpContextID que você definiu para o caractere. Ele não retorna o HelpContextID definido por outros clientes.

Observação

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

 

Consulte Também

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