IAgentNotifySinkEx::HelpComplete
[Microsoft Agent est déconseillé à partir de Windows 7 et peut ne pas être disponible dans les versions ultérieures de Windows.]
HRESULT HelpComplete(
long dwCharID, // character ID
long dwCommandID, // command ID
long dwCause // cause
);
Avertit une application cliente lorsque l’utilisateur sélectionne une commande ou un caractère pour terminer le mode d’aide.
- Pas de valeur de retour.
-
dwCharID
-
Identificateur du caractère pour lequel le mode d’aide est terminé.
-
dwCommandID
-
Identificateur de la commande sélectionnée par l’utilisateur.
-
dwCause
-
La cause de l’événement, qui peut être les valeurs suivantes :
Valeur Description const non signed Short CSHELPCAUSE _ commande = 1 ; L’utilisateur a sélectionné une commande fournie par votre application. const non signed 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 les commandes vocales. const non signed Short CSHELPCAUSE _ CLOSECOMMANDSWINDOW = 4 ; L’utilisateur a sélectionné la commande fermer les commandes vocales. const non signed Short CSHELPCAUSE _ SHOWCHARACTER = 5 ; L’utilisateur a sélectionné la commande show CharacterName . const non signed Short CSHELPCAUSE _ HIDECHARACTER = 6 ; L’utilisateur a sélectionné la commande masquer CharacterName . caractère CSHELPCAUSE short non signé _ = 7 ; L’utilisateur a sélectionné (clic) le caractère.
En général, le mode aide se termine lorsque l’utilisateur clique ou fait glisser le caractère ou sélectionne une commande dans le menu contextuel du caractère. Le fait de cliquer sur un autre caractère ou sur un autre emplacement de l’écran n’annule pas le mode d’aide. Le client qui définit le mode d’aide pour le caractère peut annuler le mode d’aide en affectant à IAgentCharacter :: HelpModeOn la valeur false. (Cela ne déclenche pas l’événement IAgentNotifySinkEx :: HelpComplete .)
Lorsque l’utilisateur sélectionne une commande à partir du menu contextuel du caractère en mode d’aide, le serveur supprime le menu, appelle l’aide avec la HelpContextIDspécifiée de la commande et envoie cet événement. Le contexte (également appelé « qu’est-ce que c’est ? ») La fenêtre d’aide s’affiche à l’emplacement du pointeur. Si l’utilisateur sélectionne la commande par entrée vocale, la fenêtre d’aide s’affiche sur le caractère. Si le caractère est hors écran, la fenêtre s’affiche à l’écran le plus proche de la position actuelle du caractère.
Si le serveur retourne dwCommandID sous la forme d’une chaîne vide (""), il indique que l’utilisateur a sélectionné une commande fournie par le serveur.
Cet événement est envoyé uniquement à l’application cliente qui place le caractère dans le mode d’aide.
Voir aussi
IAgentCharacterEx :: SetHelpModeOn, IAgentCharacterEx :: SetHelpFileName, IAgentCharacterEx :: SetHelpContextID, IAgentCommandsEx :: SetHelpContextID