IOleCommandTarget::QueryStatus 方法 (docobj.h)

查询该对象以获得由用户界面事件生成的一个或多个命令的状态。

语法

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

参数

[in] pguidCmdGroup

命令组的唯一标识符;可以为 NULL 以指定标准组。 在 prgCmds 数组中传递的所有命令都必须属于 pguidCmdGroup 指定的组。

[in] cCmds

prgCmds 数组中的命令数。

[in, out] prgCmds

调用方分配的 OLECMD 结构的数组,指示调用方需要其状态信息的命令。 此方法使用从 OLECMDF 枚举获取的值填充每个结构的 cmdf 成员。

[in, out] pCmdText

指向 OLECMDTEXT 结构的指针,在该结构中返回单个命令的名称和/或状态信息。 此参数可以为 NULL ,表示调用方不需要此信息。

返回值

此方法在成功时返回S_OK。 其他可能的返回值包括以下内容。

返回代码 说明
E_FAIL
此操作失败。
E_UNEXPECTED
发生意外错误。
E_POINTER
prgCmds 参数为 NULL
OLECMDERR_E_UNKNOWNGROUP
pguidCmdGroup 参数不为 NULL,但未指定已识别的命令组。

备注

调用方使用 QueryStatus 来确定目标对象支持哪些命令。 然后,调用方可以禁用将路由到对象的不可用命令。 调用方还可以使用此方法获取单个命令的名称或状态。

要求

   
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 docobj.h

请参阅

IOleCommandTarget

OLECMD

OLECMDF

OLECMDTEXT