Compartilhar via


IAgentCharacterEx::SetHelpModeOn

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

HRESULT SetHelpModeOn(
   long bHelpModeOn  // help mode setting
);

Define o modo de Ajuda contextual para o caractere.

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

bHelpModeOn

Sinalizador do modo de ajuda. Se esse parâmetro for True, o Microsoft Agent ativa o modo de Ajuda para o caractere.

Quando você define essa propriedade como True, o ponteiro do mouse muda para a imagem de Ajuda contextual quando movido sobre o caractere ou sobre o menu pop-up do caractere. Quando o usuário clica ou arrasta o caractere ou clica em um item no menu pop-up do caractere, o servidor dispara o IAgentNotifySinkEx::HelpComplete evento e sai do modo de Ajuda.

No modo ajuda, o servidor não envia os eventos Click, DragStart, DragCompletee Command, a menos que a propriedade GetAutoPopupMenu retorne True. Nesse caso, o servidor enviará o evento Clique (não sai do modo Ajuda), mas apenas para o botão direito do mouse para que você possa exibir o menu pop-up.

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

IAgentCharacterEx::GetHelpModeOn, IAgentNotifySinkEx::HelpComplete