IAgentCharacterEx::GetHelpContextID

[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 oHelpContextIDpara 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 do caractere.

Se você criou um arquivo de Ajuda do Windows para seu aplicativo e definiu a propriedadehelpFiledo 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.

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

Consulte Também

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