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

Recupera oHelpContextIDpara um objetode comando.

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

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

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.

Consulte Também

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