Compartir a través de

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

  • Artículo

Consulta el objeto para conocer el estado de uno o más comandos generados por eventos de interfaz de usuario.

Sintaxis

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

Parámetros

[in] pguidCmdGroup

Identificador único del grupo de comandos; puede ser NULL para especificar el grupo estándar. Todos los comandos que se pasan en la matriz prgCmds deben pertenecer al grupo especificado por pguidCmdGroup.

[in] cCmds

Número de comandos de la matriz prgCmds .

[in, out] prgCmds

Matriz asignada por el autor de la llamada de estructuras OLECMD que indican los comandos para los que el autor de la llamada necesita información de estado. Este método rellena el miembro cmdf de cada estructura con valores tomados de la enumeración OLECMDF .

[in, out] pCmdText

Puntero a una estructura OLECMDTEXT en la que se va a devolver información de nombre o estado de un solo comando. Este parámetro puede ser NULL para indicar que el autor de la llamada no necesita esta información.

Valor devuelto

Este método devuelve S_OK cuando funciona correctamente. Otros posibles valores devueltos son los siguientes.

Código devuelto Descripción
E_FAIL
 Error en la operación.
E_UNEXPECTED
 Se produjo un error inesperado.
E_POINTER
 El argumento prgCmds es NULL.
OLECMDERR_E_UNKNOWNGROUP
 El parámetro pguidCmdGroup no es NULL , pero no especifica un grupo de comandos reconocido.

Comentarios

Los autores de llamadas usan QueryStatus para determinar qué comandos son compatibles con un objeto de destino. A continuación, el autor de la llamada puede deshabilitar los comandos no disponibles que, de lo contrario, se enrutarían al objeto . El autor de la llamada también puede usar este método para obtener el nombre o el estado de un solo comando.

Requisitos

   
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado docobj.h

Consulte también

IOleCommandTarget

OLECMD

OLECMDF

OLECMDTEXT