IExtendTaskPad::GetDescriptiveText-Methode (mmc.h)

Mit der IExtendTaskPad::GetDescriptiveText-Methode kann MMC den beschreibenden Text des Taskpads abrufen, der in Taskpads angezeigt wird, die MMC-Taskpadvorlagen verwenden.

Syntax

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

Parameter

[in] pszGroup

Ein Zeiger auf eine NULL-Zeichenfolge, die den Gruppennamen enthält, der das Taskpad identifiziert. Der Gruppenname ist die Zeichenfolge, die dem Hash (#) in der Zeichenfolge folgt, die im ppViewType-Parameter übergeben wird, wenn MMC IComponent::GetResultViewType aufruft, um das Taskpad anzuzeigen. Wenn kein Gruppenname angegeben ist, ist szGroup eine NULL-Zeichenfolge .

[out] pszDescriptiveText

Ein Zeiger auf die Adresse einer null-beendeten Zeichenfolge, die den beschreibenden Text für das von pszGroup angegebene Taskpad enthält. Dieser Text wird am oberen Rand des Taskpads unter dem Titel für das gesamte Taskpad angezeigt. Dieser Text kann ein Ausdruck sein, der als Untertitel oder Anweisungen dient (z. B. "Klicken Sie auf eine auszuführende Aktion)."

Wenn pszDescriptiveText auf eine NULL-Zeichenfolge verweist, wird kein beschreibender Text angezeigt.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Hinweise

Ordnen Sie die Zeichenfolge pszDescriptiveText mit der COM-API-Funktion CoTaskMemAlloc (oder der entsprechenden) zu, und MMC gibt sie frei.

Anforderungen

Weitere Informationen

IExtendTaskPad