IAgentCommandsEx::SetHelpContextID

[O Microsoft Agent foi preterido a partir do Windows 7 e pode não estar disponível em versões subsequentes do Windows.]

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

Define o HelpContextID para um Command objeto.

• 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 objetoCommand; 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 personagem. O agente 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. Se houver um número de contexto na propriedade HelpContextID do comando selecionado, a Ajuda exibirá um tópico correspondente ao contexto atual da Ajuda; caso contrário, exibe "Nenhum tópico da Ajuda associado a este item".

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