Partager via


IAgentCharacterEx::GetActive

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

HRESULT GetActive(
   short * psState  // address of active state setting
);

Permet de savoir si votre application client est le client actif du personnage et si le personnage est le plus haut placé.

  • Renvoie S_OK pour indiquer que l'opération a réussi.

psState

Adresse d'une variable qui reçoit l'une des valeurs suivantes pour le paramètre d'état :

Valeur Description
const unsigned short ACTIVATE_NOTACTIVE = 0;
Votre client n'est pas le client actif du personnage.
const unsigned short ACTIVATE_ACTIVE = 1;
Votre client est le client actif du personnage.
const unsigned short ACTIVATE_INPUTACTIVE = 2;
Votre client est actif à l'entrée (client actif du caractère le plus haut).

Ce paramètre vous permet de savoir si vous êtes le client actif du personnage ou si votre personnage est le personnage actif en entrée. Lorsque plusieurs applications clientes partagent le même personnage, c'est le client actif du personnage qui reçoit les données de la souris (par exemple, les événements de clic ou de glissement du contrôle Microsoft Agent). De même, lorsque plusieurs caractères sont affichés, le client actif du caractère le plus haut (également appelé client actif en entrée) reçoit les événements IAgentNotifySink::Command.

Utilisez la méthode Activate pour déterminer si votre application est le client actif du personnage ou pour faire de votre application le client actif de l'entrée (ce qui place également le personnage en tête de liste).

Voir aussi

IAgentCharacter::Activate, IAgentNotifySinkEx::ActiveClientChange