IOleCommandTarget::QueryStatus メソッド (docobj.h)

  • [アーティクル]

ユーザー インターフェイスのイベントによって生成された 1 つ以上のコマンドの状態のオブジェクトを照会します。

構文

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 構造体の呼び出し元によって割り当てられた配列。 このメソッドは、各構造体の cmdf メンバーに OLECMDF 列挙から取得された値を入力します。

[in, out] pCmdText

1 つのコマンドの名前や状態情報を返す OLECMDTEXT 構造体へのポインター。 呼び出し元がこの情報を必要としないことを示すには、このパラメーターに NULL を 指定できます。

戻り値

このメソッドは、成功したS_OKを返します。 その他の可能な戻り値は次のとおりです。

リターン コード 説明
E_FAIL
 操作が失敗しました。
E_UNEXPECTED
 予期しないエラーが発生しました。
E_POINTER
 prgCmds 引数は NULL です。
OLECMDERR_E_UNKNOWNGROUP
 pguidCmdGroup パラメーターは NULL ではありませんが、認識されたコマンド グループは指定しません。

解説

呼び出し元は QueryStatus を 使用して、ターゲット オブジェクトでサポートされているコマンドを決定します。 呼び出し元は、それ以外の場合は オブジェクトにルーティングされる使用できないコマンドを無効にすることができます。 呼び出し元は、このメソッドを使用して、1 つのコマンドの名前または状態を取得することもできます。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー docobj.h

関連項目

IOleCommandTarget

OLECMD

OLECMDF

OLECMDTEXT