Share via

IKsFormatSupport::GetDevicePreferredFormat-Methode (devicetopology.h)

  • Artikel

Die GetDevicePreferredFormat-Methode ruft das bevorzugte Audiostreamformat für die Verbindung ab.

Syntax

HRESULT GetDevicePreferredFormat(
  [out] PKSDATAFORMAT *ppKsFormat
);

Parameter

[out] ppKsFormat

Zeiger auf eine Zeigervariable, in die die Methode die Adresse eines Puffers schreibt, der den Formatbezeichner für das bevorzugte Format enthält. Der Spezifizierer beginnt mit einer KSDATAFORMAT-Struktur , auf die möglicherweise zusätzliche Formatinformationen folgen. Die -Methode ordnet den Speicher für den Formatbezeichner zu. Der Aufrufer ist dafür verantwortlich, den Speicher frei zu geben, wenn er nicht mehr benötigt wird, indem er die CoTaskMemFree-Funktion aufruft. Wenn die Methode fehlschlägt, ist *ppKsFormatNULL. Weitere Informationen zu KSDATAFORMAT, Formatbezeichnern und CoTaskMemFree finden Sie in der Dokumentation zu Windows DDK.

Rückgabewert

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Wenn ein Fehler auftritt, umfassen mögliche Rückgabecodes die in der folgenden Tabelle gezeigten Werte, sind jedoch nicht darauf beschränkt.

Rückgabecode Beschreibung
E_POINTER
 Zeiger ppKsFormat ist NULL.
E_OUTOFMEMORY
 Nicht genügend Arbeitsspeicher.

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 devicetopology.h

Weitere Informationen

IKsFormatSupport-Schnittstelle