IAgentCharacterEx::GetHelpContextID

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

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

Recupera o HelpContextID do personagem.

• 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ê criou um arquivo de Ajuda do Windows para seu aplicativo e definiu a propriedade HelpFile do personagem, o Microsoft Agent chama automaticamente a Ajuda quando HelpModeOn é definido como True e o usuário seleciona 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.

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

Ver também

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