IAgentCommandEx::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 * pulID  //  address of command's help topic ID
);

Recupera o HelpContextID para um Command objeto.

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

pulID

Endereço de uma variável que recebe o número de contexto do tópico de ajuda associado ao objeto Command.

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

Observação

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

 

Ver também

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