ITocEntry::GetTitle-Methode (wmcodecdsp.h)

  • Artikel

Die GetTitle-Methode ruft den Titel des Eintrags ab, der durch einen vorherigen Aufruf von SetTitle festgelegt wurde.

Syntax

HRESULT GetTitle(
  [in, out] WORD   *pwTitleSize,
  [out]     LPWSTR pwszTitle
);

Parameter

[in, out] pwTitleSize

Wenn pwszTitleNULL ist, ist dies ein Ausgabeparameter, der die Größe des Puffers in Breitzeichen empfängt, der zum Empfangen des Titels erforderlich ist. Wenn pwszTitle nicht NULL ist, ist dies ein Eingabeparameter, der die Größe des vom Aufrufer zugeordneten Puffers in Breitzeichen angibt, auf den pwszTitle verweist.

[out] pwszTitle

NULL oder ein Zeiger auf einen vom Aufrufer zugewiesenen Puffer, der bei erfolgreicher Fertigstellung den Titel empfängt. Der Titel 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
S_OK
 Die Methode wurde erfolgreich ausgeführt.
MF_E_BUFFERTOOSMALL
 Die -Methode gibt diesen Fehlercode zurück, wenn pwszTitle nicht NULL ist und der Titel einschließlich seines NULL-Abschlusszeichens größer als die von pwTitleSize angegebene Größe ist. In diesem Fall dient pwTitleSize 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

Weitere Informationen

ITocEntry

SetTitle