ITocEntry::GetDescriptionData-Methode (wmcodecdsp.h)

  • Artikel

Die GetDescriptionData-Methode ruft einen Beschreibungsdatenblock ab, der dem Eintrag zuvor durch einen Aufruf von SetDescriptionData zugeordnet wurde.

Syntax

HRESULT GetDescriptionData(
  [in, out] DWORD *pdwDescriptionDataSize,
  [out]     BYTE  *pbtDescriptionData,
  [out]     GUID  *pGuidType
);

Parameter

[in, out] pdwDescriptionDataSize

Wenn pbtDescriptionDataNULL ist, ist dies ein Ausgabeparameter, der die Größe des Description-Datenblocks in Bytes empfängt. Wenn pbtDescriptionData nicht NULL ist, ist dies ein Eingabeparameter, der die Größe des vom Aufrufer zugeordneten Puffers in Bytes angibt, auf den pbtDescriptionData verweist.

[out] pbtDescriptionData

NULL oder ein Zeiger auf einen vom Aufrufer zugewiesenen Puffer, der bei erfolgreicher Fertigstellung den Beschreibungsdatenblock empfängt.

[out] pGuidType

Zeiger auf eine Variable, die eine GUID (Globally Unique Identifier) empfängt, die den Datentyp im Beschreibungsdatenblock identifiziert. Siehe Hinweise.

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
S_OK
 Die Methode wurde erfolgreich ausgeführt.
MF_E_BUFFERTOOSMALL
 Die -Methode gibt diesen Fehlercode zurück, wenn pbtDescriptionData nicht NULL ist und der Kontextblock größer als die von pdwDescriptionDataSize angegebene Größe ist. In diesem Fall dient pdwDescriptionDataSize als Ausgabeparameter und empfängt die Größe des erforderlichen Puffers in Bytes.

Hinweise

Sie können einem bestimmten Eintrag zu einem bestimmten Zeitpunkt nur einen Beschreibungsdatenblock zuordnen. Möglicherweise möchten Sie jedoch verschiedene Arten von Beschreibungsdatenblöcken entwerfen und jeden Blocktyp mit einem global eindeutigen Bezeichner (GUID) identifizieren. Auf diese Weise können Sie beim Aufrufen von SetDescriptionData den Datenblock als einen bestimmten Typ markieren. Wenn Sie GetDescriptionData aufrufen, können Sie den Typ des abgerufenen Datenblocks ermitteln, indem Sie den in pGuidType zurückgegebenen Wert überprüfen.

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

Weitere Informationen

ITocEntry

SetDescriptionData