IAgentCharacterEx::SetHelpContextID

[O Microsoft Agent foi preterido a partir do Windows 7 e pode não estar disponível em versões subsequentes do Windows.]

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

Define o HelpContextID para o personagem.

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

ulHelpID

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

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 noHelpContextID, 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 personagem. Se houver um número de contexto na propriedade HelpContextID, a Ajuda exibirá um tópico correspondente ao contexto atual da Ajuda; caso contrário, exibe "Nenhum tópico da Ajuda associado a este item".

Essa configuração se aplica somente quando seu aplicativo cliente é o cliente ativo do caractere mais alto. Isso não afeta outros clientes do caractere ou outros caracteres que seu aplicativo cliente está usando.

Ver também

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