IAgentCharacterEx::GetHelpModeOn

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

HRESULT GetHelpModeOn(
   long * pbHelpModeOn  // address of help mode setting
);

Recupera se o modo de Ajuda contextual está ativado para o caractere.

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

pbHelpModeOn

Endereço de uma variável que recebe True se o modo de Ajuda estiver ativado para o caractere e False se não estiver.

Quando essa propriedade é definida 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 o IAgentNotifySink::Click, IAgentNotifySink::D ragStart, IAgentNotifySink::D ragCompletee IAgentNotifySink::Command events, a menos que propriedade GetAutoPopupMenu retorne True. Nesse caso, o servidor enviará o evento IAgentNotifySink::Click (não sai do modo ajuda), mas apenas para o botão direito do mouse para permitir que você exiba 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::SetHelpModeOn