Méthode IOleCommandTarget::QueryStatus (docobj.h)

Article
08/23/2023

Interroge l'objet sur l'état d'une ou de plusieurs commandes générées par les événements d'interface utilisateur.

Syntaxe

HRESULT QueryStatus(
  [in]      const GUID *pguidCmdGroup,
  [in]      ULONG      cCmds,
  [in, out] OLECMD []  prgCmds,
  [in, out] OLECMDTEXT *pCmdText
);

Paramètres

[in] pguidCmdGroup

Identificateur unique du groupe de commandes ; peut avoir la valeur NULL pour spécifier le groupe standard. Toutes les commandes passées dans le tableau prgCmds doivent appartenir au groupe spécifié par pguidCmdGroup.

[in] cCmds

Nombre de commandes dans le tableau prgCmds .

[in, out] prgCmds

Tableau alloué à l’appelant de structures OLECMD qui indiquent les commandes pour lesquelles l’appelant a besoin d’informations status. Cette méthode remplit le membre cmdf de chaque structure avec des valeurs extraites de l’énumération OLECMDF .

[in, out] pCmdText

Pointeur vers une structure OLECMDTEXT dans laquelle retourner le nom et/ou status informations d’une seule commande. Ce paramètre peut avoir la valeur NULL pour indiquer que l’appelant n’a pas besoin de ces informations.

Valeur retournée

Cette méthode retourne S_OK en cas de réussite. Les autres valeurs de retour possibles sont les suivantes.

Code de retour	Description
E_FAIL	L'opération a échoué.
E_UNEXPECTED	Une erreur inattendue s’est produite.
E_POINTER	L’argument prgCmds est NULL.
OLECMDERR_E_UNKNOWNGROUP	Le paramètre pguidCmdGroup n’a pas la valeur NULL , mais ne spécifie pas de groupe de commandes reconnu.

Notes

Les appelants utilisent QueryStatus pour déterminer les commandes prises en charge par un objet cible. L’appelant peut ensuite désactiver les commandes non disponibles qui seraient autrement routées vers l’objet. L’appelant peut également utiliser cette méthode pour obtenir le nom ou la status d’une seule commande.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	docobj.h

Voir aussi

Partager via