IToc::GetDescription-Methode (wmcodecdsp.h)
Die GetDescription-Methode ruft die Durch einen vorherigen Aufruf von SetDescription festgelegte Beschreibung des Inhaltsverzeichnisses ab.
Syntax
HRESULT GetDescription(
[in, out] WORD *pwDescriptionSize,
[out] LPWSTR pwszDescription
);
Parameter
[in, out] pwDescriptionSize
Wenn pwszDescriptionNULL ist, ist dies ein Ausgabeparameter, der die Größe des Puffers in Breitzeichen empfängt, der zum Empfangen der Beschreibung erforderlich ist. Wenn pwszDescription nicht NULL ist, ist dies ein Eingabeparameter, der die Größe des vom Aufrufer zugeordneten Puffers in Breitzeichen angibt, auf den pwszDescription verweist.
[out] pwszDescription
NULL oder ein Zeiger auf einen vom Aufrufer zugewiesenen Puffer, der bei erfolgreicher Fertigstellung die Beschreibung empfängt. Die Beschreibung ist NULL-endend.
Rückgabewert
Die Methode gibt ein HRESULT zurück. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.
| Rückgabecode | BESCHREIBUNG |
|---|---|
|
Die Methode wurde erfolgreich ausgeführt. |
|
Die -Methode gibt diesen Fehlercode zurück, wenn pwszDescription nicht NULL ist und die Beschreibung einschließlich des NULL-Abschlusszeichens größer als die von pwDescriptionSize angegebene Größe ist. In diesem Fall dient pwDescriptionSize als Ausgabeparameter und empfängt die Größe des erforderlichen Puffers. |
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows Vista [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2008 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | wmcodecdsp.h |
| DLL | Wmvdspa.dll |