Compartilhar via

IAgentCharacterEx::SetHelpContextID

  • Artigo

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

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Define oHelpContextIDpara o caractere.

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

ulHelpID

O número de contexto do tópico de ajuda associado a um caractere; usado para fornecer ajuda contextual para o caractere.

Se você criou um arquivo de Ajuda do Windows para seu aplicativo e o definiu na propriedade HelpFile do caractere, o Microsoft Agent chamará automaticamente a Ajuda quando HelpModeOn estiver definido como True e o usuário selecionará o caractere. Se houver um número de contexto no HelpContextID, o Agente 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. Se houver um número de contexto na propriedade HelpContextID, 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 configuração se aplica somente quando o aplicativo cliente é o cliente ativo do caractere mais alto. Ele não afeta outros clientes do caractere ou outros caracteres que seu aplicativo cliente está usando.

Nota

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

 

Consulte Também

IAgentCharacterEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName