Compartilhar via

IAgentCommandsEx::GetHelpContextID

  • Artigo

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

Recupera o HelpContextID para um objeto Command .

  • 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 objeto Command .

Se você tiver criado um arquivo de Ajuda do Windows para seu aplicativo e definido a propriedade HelpFile do caractere, o Microsoft Agent chamará a Ajuda automaticamente quando HelpModeOn estiver definido como True e o usuário selecionar o objeto Command . Se houver um número de contexto no HelpContextID, o Agent 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 .

Essa propriedade se aplica somente ao uso do caractere pelo aplicativo cliente; a configuração não afeta outros clientes do caractere ou outros caracteres do aplicativo cliente.

Observação

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

 

Consulte Também

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