Compartilhar via

IAgentCommandsEx::SetHelpContextID

  • Artigo

[O Microsoft Agent foi preterido a partir do Windows 7 e pode estar indisponível nas versões subsequentes do Windows.]

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Define o HelpContextID para um objeto Command .

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

ulHelpID

O número de contexto do tópico de ajuda associado ao objeto Command ; usado para fornecer ajuda contextual para o comando.

Se você criou um arquivo de Ajuda do Windows para seu aplicativo e o definiu na propriedade HelpFile do caractere. O agente chama a Ajuda automaticamente quando HelpModeOn é definido como True e o usuário seleciona o comando. Se houver um número de contexto no HelpContextID, o Agent chamará 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 . Se houver um número de contexto na propriedade HelpContextID do comando selecionado, a Ajuda exibirá um tópico correspondente ao contexto da Ajuda atual; caso contrário, ele exibirá "Nenhum tópico de Ajuda associado a este item".

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::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName