Compartilhar via

IAgentNotifySinkEx::HelpComplete

  • Artigo

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

HRESULT HelpComplete(
   long dwCharID,     // character ID
   long dwCommandID,  // command ID
   long dwCause       // cause 
);

Notifica um aplicativo cliente quando o usuário seleciona um comando ou caractere para concluir o modo de Ajuda.

  • Nenhum valor retornado.

dwCharID

Identificador do caractere para o qual o modo de Ajuda foi concluído.

dwCommandID

Identificador do comando selecionado pelo usuário.

dwCause

A causa do evento, que pode ser os valores a seguir:

Valor Descrição
const unsigned short CSHELPCAUSE_COMMAND = 1;
 O usuário selecionou um comando fornecido pelo aplicativo.
const unsigned short CSHELPCAUSE_OTHERPROGRAM = 2;
 O usuário selecionou o objeto Commands de outro cliente.
const unsigned short CSHELPCAUSE_OPENCOMMANDSWINDOW = 3;
 O usuário selecionou o comando Open Voice Commands.
const unsigned short CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;
 O usuário selecionou o comando Close Voice Commands.
const unsigned short CSHELPCAUSE_SHOWCHARACTER = 5;
 O usuário selecionou o comando Show CharacterName.
const unsigned short CSHELPCAUSE_HIDECHARACTER = 6;
 O usuário selecionou o comando Hide CharacterName.
const unsigned short CSHELPCAUSE_CHARACTER = 7;
 O usuário selecionou o (clicou no) caractere.

Normalmente, o modo de Ajuda é concluído quando o usuário clica ou arrasta o caractere ou seleciona um comando no menu pop-up do caractere. Clicar em outro caractere ou em outro lugar da tela não cancela o modo de Ajuda. O cliente que definiu o modo de Ajuda para o caractere pode cancelar o modo de Ajuda definindo IAgentCharacter::HelpModeOn como False. (Isso não aciona o evento IAgentNotifySinkEx::HelpComplete.)

Quando o usuário seleciona um comando no menu pop-up do caractere no modo de Ajuda, o servidor remove o menu, chama a Ajuda com o HelpContextID especificado do comando e envia esse evento. A janela Ajuda sensível ao contexto (também conhecida como O que é isso?) é exibida no local do ponteiro. Se o usuário selecionar o comando por entrada de voz, a janela Ajuda será exibida sobre o caractere. Se o caractere estiver fora da tela, a janela será exibida na tela mais próxima da posição atual do caractere.

Se o servidor retornar dwCommandID como uma cadeia de caracteres vazia (""), isso indicará que o usuário selecionou um comando fornecido pelo servidor.

Esse evento será enviado somente para o aplicativo cliente que coloca o caractere no modo de Ajuda.

Confira também

IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName, IAgentCharacterEx::SetHelpContextID, IAgentCommandsEx::SetHelpContextID