IAgentNotifySinkEx::HelpComplete

[Microsoft Agent est déconseillé à partir de Windows 7 et peut être indisponible dans les versions ultérieures de Windows.]

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

Notifie une application cliente lorsque l'utilisateur sélectionne une commande ou un caractère pour terminer le mode Aide.

• Aucune valeur renvoyée.

dwCharID

Identifiant du caractère pour lequel le mode Aide s'est achevé.

dwCommandID

Identifiant de la commande sélectionnée par l'utilisateur.

dwCause

La cause de l'événement, qui peut prendre les valeurs suivantes :

Valeur	Description
const unsigned short CSHELPCAUSE_COMMAND = 1;	L'utilisateur a sélectionné une commande fournie par votre application.
const unsigned short CSHELPCAUSE_OTHERPROGRAM = 2;	L'utilisateur a sélectionné l'objet Commandes d'un autre client.
const unsigned short CSHELPCAUSE_OPENCOMMANDSWINDOW = 3;	L'utilisateur a sélectionné la commande Ouvrir la commande vocale.
const unsigned short CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;	L'utilisateur a sélectionné la commande Close Voice Commands.
const unsigned short CSHELPCAUSE_SHOWCHARACTER = 5;	L'utilisateur a sélectionné la commande Afficher le nom du personnage.
const unsigned short CSHELPCAUSE_HIDECHARACTER = 6;	L'utilisateur a sélectionné la commande Masquer le nom du personnage.
const unsigned short CSHELPCAUSE_CHARACTER = 7;	L'utilisateur a sélectionné (cliqué) le personnage.

En règle générale, le mode Aide se termine lorsque l'utilisateur clique ou fait glisser le personnage ou sélectionne une commande dans la fenêtre contextuelle du personnage. Le fait de cliquer sur un autre caractère ou ailleurs à l'écran n'annule pas le mode Aide. Le client qui a défini le mode Aide pour le personnage peut l'annuler en attribuant la valeur False à IAgentCharacter::HelpModeOn. (Cela ne déclenche pas l'événement IAgentNotifySinkEx::HelpComplete).

Lorsque l'utilisateur sélectionne une commande dans le menu contextuel du personnage en mode Aide, le serveur supprime le menu, appelle l'Aide avec le HelpContextID spécifié pour la commande et envoie cet événement. La fenêtre d'aide contextuelle (également appelée "Qu'est-ce que c'est ?") s'affiche à l'emplacement du pointeur. Si l'utilisateur sélectionne la commande par saisie vocale, la fenêtre d'aide s'affiche au-dessus du personnage. Si le personnage n'est pas à l'écran, la fenêtre est affichée à l'écran le plus près de la position actuelle du personnage.

Si le serveur renvoie dwCommandID sous la forme d'une chaîne vide (""), cela signifie que l'utilisateur a sélectionné une commande fournie par le serveur.

Cet événement n'est envoyé qu'à l'application cliente qui place le personnage en mode Aide.

Voir aussi

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