Partager via

IAgentCharacterEx ::GetHelpModeOn

  • Article

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

HRESULT GetHelpModeOn(
   long * pbHelpModeOn  // address of help mode setting
);

Récupère si le mode d’aide respectant le contexte est activé pour le caractère.

  • Retourne S_OK pour indiquer que l’opération a réussi.

pbHelpModeOn

Adresse d’une variable qui reçoit True si le mode Aide est activé pour le caractère et False si ce n’est pas le cas.

Lorsque cette propriété est définie sur True, le pointeur de la souris passe à l’image d’aide contextuelle lorsqu’elle est déplacée sur le caractère ou sur le menu contextuel du caractère. Lorsque 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 Aide, le serveur n’envoie pas le IAgentNotifySink ::Click, IAgentNotifySink ::D ragStart, IAgentNotifySink ::D ragCompleteet événements IAgentNotifySink ::Command, sauf si propriété GetAutoPopupMenu retourne True. Dans ce cas, le serveur envoie l’événement IAgentNotifySink ::Click (ne quitte pas le mode 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 de votre application cliente du caractère ; le paramètre n’affecte pas d’autres clients du caractère ou d’autres caractères de votre application cliente.

Voir aussi

IAgentCharacterEx ::SetHelpModeOn