IAgentCommandsEx::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 Commands object help topic ID
);

Recupera o HelpContextID para um Command objeto.

• 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 objetoCommand.

Se você criou um arquivo de Ajuda do Windows para seu aplicativo e definiu a propriedadeHelpFiledo personagem, o Microsoft Agent chamará automaticamente a Ajuda quando HelpModeOn estiver definido como True e o usuário selecionar seu objeto Command. 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 objeto Command.

Esta propriedade aplica-se apenas ao uso do caractere pelo seu aplicativo cliente; A configuração não afeta outros clientes do caractere ou outros caracteres do seu aplicativo cliente.

Ver também

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