Compartir a través de

IAgentNotifySinkEx::HelpComplete

  • Artículo

[Microsoft Agent está en desuso a partir de Windows 7 y puede no estar disponible en versiones posteriores de Windows].

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

Notifica a una aplicación cliente cuándo selecciona el usuario un comando o carácter para completar el modo de ayuda.

  • No devuelve ningún valor.

dwCharID

Identificador del carácter para el que se completó el modo de ayuda.

dwCommandID

Identificador del comando seleccionado por el usuario.

dwCause

Causa del evento, que puede tener los siguientes valores:

Valor Descripción
const unsigned short CSHELPCAUSE_COMMAND = 1;
 El usuario seleccionó un comando facilitado por la aplicación.
const unsigned short CSHELPCAUSE_OTHERPROGRAM = 2;
 El usuario seleccionó el objeto Commands de otro cliente.
const unsigned short CSHELPCAUSE_OPENCOMMANDSWINDOW = 3;
 El usuario seleccionó el comando Open Voice Commands (Abrir comandos de voz).
const unsigned short CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;
 El usuario seleccionó el comando Close Voice Commands (Cerrar comandos de voz).
const unsigned short CSHELPCAUSE_SHOWCHARACTER = 5;
 El usuario seleccionó el comando Show (Mostrar) CharacterName.
const unsigned short CSHELPCAUSE_HIDECHARACTER = 6;
 El usuario seleccionó el comando Hide (Ocultar) CharacterName.
const unsigned short CSHELPCAUSE_CHARACTER = 7;
 El usuario seleccionó el carácter (o hizo clic en él).

Normalmente, el modo de ayuda se completa cuando el usuario hace clic o arrastra el carácter o selecciona un comando en el menú emergente del carácter. Al hacer clic en otro carácter o en otro lugar de la pantalla, no se cancela el modo de ayuda. El cliente que activa el modo de ayuda del carácter puede cancelar el modo de ayuda cambiando IAgentCharacter::HelpModeOn a False. (Esto no activa el evento IAgentNotifySinkEx::HelpComplete).

Cuando el usuario selecciona un comando en el menú emergente del carácter en modo de ayuda, el servidor eliminará el menú, llamará a Ayuda con el HelpContextID del comando indicado y enviará el evento. La ventana de ayuda contextual (también conocida como ¿Qué es esto?) aparece en la ubicación del puntero. Si el usuario selecciona el comando por entrada de voz, en la ventana Ayuda aparecerá sobre el personaje. Si el caráctere está fuera de la pantalla, la ventana se verá en una posición más cercana a la posición actual del carácter.

Si el servidor devuelve dwCommandID como una cadena vacía (""), indicará que el usuario ha seleccionado un comando facilitado por el servidor.

Este evento solo se envía a la aplicación cliente que coloca el carácter en modo Ayuda.

Consulte también

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