IConsole2::SetStatusText メソッド (mmc.h)

IConsole2::SetStatusText メソッドを使用すると、スナップインでステータス バーのテキストを変更できます。 これは IComponent のインスタンスでのみ使用されることに注意してください。

構文

HRESULT SetStatusText(
  [in] LPOLESTR pszStatusText
);

パラメーター

[in] pszStatusText

ステータス バーに表示するテキストを含む null で終わる文字列へのポインター。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

注釈

ステータス バーには、パイプ文字 (|) で区切られた 3 つのセクションがあります。 たとえば、ステータス バーのテキストを "Left|ミドル|Right" では、ステータス バーの左端のセクションに "Left" が配置され、中央のセクションに "Middle" が配置され、右端のセクションに "Right" が配置されます。

3 つ以上のフィールドが区切られている場合 (つまり、パイプが 2 つ以上ある場合)、4 番目以降のフィールドに配置されるすべてのフィールドは省略されます。

さらに、中央のセクションは進行状況バーとして機能するように設計されています。 この機能は、最初の文字として '%' 文字を渡し、その後に 0 ~ 100 の数値を中央のセクションに渡すことによって呼び出されます。 テキストの代わりに、このセクションには、完了率が 0 ~ 100% の進行状況バーが表示されます。 たとえば、"Done|%75" を渡すと、左側のセクションに "Done" が配置され、中央のセクションに進行状況バー 75% が完了します。

ステータス バーの中央セクションに '%' で始まる文字列を表示するには、文字列を '%%' で始めます。 これにより、中央のセクションにテキストが表示され、最初の '%' が削除されます。 たとえば、"Today is|%wednesday%" の場合、"Today is" を含む左側のセクションと、"%Wednesday%" を含む中央のセクションが表示されます。 '%' の後の中央のセクションに無効な数値または数値以外のテキストが入力された場合、中央のセクションは空になります。 セクション内で '%' が唯一の文字である場合は、テキストとして表示されます。

このメソッドは、IComponent を介して取得した IConsole2 インターフェイス ポインターから呼び出す必要があります。

ステータス バーのテキストを変更できるのは、現在選択されているスコープアイテムを所有するスナップインのみです。

MMC バージョン 1.1 以降では、各マルチドキュメント インターフェイス (MDI) の子ウィンドウにステータス バーがあります。

要件

要件	値
サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
対象プラットフォーム	Windows
ヘッダー	mmc.h
[DLL]	Mmcndmgr.dll

こちらもご覧ください

IConsole2