IOleCommandTarget::QueryStatus-Methode (docobj.h)

Artikel
08/23/2023

Fragt das Objekt nach dem Status eines oder mehrerer Befehle ab, die von Benutzeroberflächenereignissen generiert wurden.

Syntax

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

Parameter

[in] pguidCmdGroup

Der eindeutige Bezeichner der Befehlsgruppe; kann NULL sein, um die Standardgruppe anzugeben. Alle Befehle, die im prgCmds-Array übergeben werden, müssen zu der von pguidCmdGroup angegebenen Gruppe gehören.

[in] cCmds

Die Anzahl der Befehle im PrgCmds-Array .

[in, out] prgCmds

Ein vom Aufrufer zugewiesenes Array von OLECMD-Strukturen, das die Befehle angibt, für die der Aufrufer status Informationen benötigt. Diese Methode füllt das cmdf-Element jeder Struktur mit Werten aus der OLECMDF-Enumeration .

[in, out] pCmdText

Ein Zeiger auf eine OLECMDTEXT-Struktur, in der name und/oder status Informationen eines einzelnen Befehls zurückgegeben werden sollen. Dieser Parameter kann NULL sein, um anzugeben, dass der Aufrufer diese Informationen nicht benötigt.

Rückgabewert

Diese Methode gibt S_OK bei Erfolg zurück. Weitere mögliche Rückgabewerte:

Rückgabecode	Beschreibung
E_FAIL	Fehler beim Vorgang.
E_UNEXPECTED	Ein unerwarteter Fehler ist aufgetreten.
E_POINTER	Das prgCmds-Argument ist NULL.
OLECMDERR_E_UNKNOWNGROUP	Der pguidCmdGroup-Parameter ist nicht NULL , gibt aber keine erkannte Befehlsgruppe an.

Hinweise

Aufrufer verwenden QueryStatus , um zu bestimmen, welche Befehle von einem Zielobjekt unterstützt werden. Der Aufrufer kann dann nicht verfügbare Befehle deaktivieren, die andernfalls an das Objekt weitergeleitet würden. Der Aufrufer kann diese Methode auch verwenden, um den Namen oder status eines einzelnen Befehls abzurufen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	docobj.h

Weitere Informationen