IAgentCommandEx::SetHelpContextID

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

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

Define oHelpContextIDpara um objeto dede comando.

• 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 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 Microsoft Agent chama a Ajuda automaticamente quando HelpModeOn está definido como True e o usuário seleciona o comando. 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 comando.

Nota

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

 

Consulte Também

IAgentCommandEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName