IAgentCharacterEx::GetHelpModeOn

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

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

Recupera se o modo de Ajuda sensível ao contexto está ativado para o personagem.

• 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 Ajuda estiver ativado para o caractere e False se não.

Quando essa propriedade é definida como True, o ponteiro do mouse muda para a imagem da Ajuda sensível ao contexto 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 aciona o evento IAgentNotifySinkEx::HelpComplete e sai do modo de Ajuda.

No modo de Ajuda, o servidor não envia o IAgentNotifySink::Click, IAgentNotifySink::D ragStart, IAgentNotifySink::D ragCompletee IAgentNotifySink::Command eventos, a menos que propriedade GetAutoPopupMenu retorne True. Nesse caso, o servidor enviará o IAgentNotifySink::Click evento (não sai do modo de Ajuda), mas apenas para o botão direito do mouse para permitir que você exiba o menu pop-up.

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

IAgentCharacterEx::SetHelpModeOn