IExtendTaskPad::GetDescriptiveText メソッド (mmc.h)

IExtendTaskPad::GetDescriptiveText メソッドを使用すると、MMC は、MMC タスクパッド テンプレートを使用するタスクパッドに表示するタスクパッドの説明テキストを取得できます。

構文

HRESULT GetDescriptiveText(
  [in]  LPOLESTR pszGroup,
  [out] LPOLESTR *pszDescriptiveText
);

パラメーター

[in] pszGroup

タスクパッドを識別するグループ名を含む null で終わる文字列へのポインター。 グループ名は、MMC が IComponent::GetResultViewType を呼び出してタスクパッドを表示するときに ppViewType パラメーターで渡される文字列のハッシュ (#) に続く文字列です。 グループ名が指定されていない場合、szGroup は NULL 文字列です。

[out] pszDescriptiveText

pszGroup で指定されたタスクパッドの説明テキストを含む null で終わる文字列のアドレスへのポインター。 このテキストは、タスクパッド全体のタイトルの下のタスクパッドの上部に表示されます。 このテキストには、サブタイトルまたは命令として機能する語句を指定できます ("実行するアクションをクリックしてください" など)。

pszDescriptiveText が NULL 文字列を指している場合、説明テキストは表示されません。

戻り値

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

注釈

COM API 関数 CoTaskMemAlloc (またはそれに相当する) を使用して pszDescriptiveText 文字列を割り当てると、MMC によって解放されます。

要件

こちらもご覧ください

IExtendTaskPad