IAgentCharacterEx::GetHelpModeOn
[Microsoft Agent est déconseillé à partir de Windows 7 et peut ne pas être disponible dans les versions ultérieures de Windows.]
HRESULT GetHelpModeOn(
long * pbHelpModeOn // address of help mode setting
);
Récupère une valeur indiquant si le mode d’aide contextuelle est activé pour le caractère.
- Retourne _ la valeur S OK pour indiquer que l’opération a réussi.
-
pbHelpModeOn
-
Adresse d’une variable qui reçoit true si le mode d’aide est activé pour le caractère et false dans le cas contraire.
Lorsque cette propriété est définie sur true, le pointeur de la souris se transforme en image d’aide contextuelle lorsqu’il est déplacé sur le caractère ou sur le menu contextuel du caractère. Quand l’utilisateur clique ou fait glisser le caractère ou clique sur un élément dans le menu contextuel du caractère, le serveur déclenche l’événement IAgentNotifySinkEx :: HelpComplete et quitte le mode d’aide.
En mode d’aide, le serveur n’envoie pas les événements IAgentNotifySink :: Click, IAgentNotifySink ::D ragstart, IAgentNotifySink ::D Ragcompleteet IAgentNotifySink :: Command , sauf si la propriété GetAutoPopupMenu retourne la valeur true. Dans ce cas, le serveur enverra l’événement IAgentNotifySink :: Click (ne quitte pas le mode d’aide), mais uniquement pour le bouton droit de la souris pour vous permettre d’afficher le menu contextuel.
Cette propriété s’applique uniquement à l’utilisation du caractère par votre application cliente ; le paramètre n’affecte pas les autres clients du caractère ou d’autres caractères de votre application cliente.