IAgentCommandEx::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 ulID  //  ID for help topic
);

Define o HelpContextID para um Command objeto.

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

ulID

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 Microsoft Agent chama automaticamente a Ajuda quando HelpModeOn é 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::GetHelpContextID IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName