IAudioSessionControl::GetDisplayName-Methode (audiopolicy.h)

Die GetDisplayName-Methode ruft den Anzeigenamen für die Audiositzung ab.

Syntax

HRESULT GetDisplayName(
  [out] LPWSTR *pRetVal
);

Parameter

[out] pRetVal

Zeiger auf eine Zeigervariable, in die die -Methode die Adresse einer mit NULL beendeten breitzeichenigen Zeichenfolge schreibt, die den Anzeigenamen enthält. Die -Methode weist den Speicher für die Zeichenfolge zu. Der Aufrufer ist für das Freigeben des Speichers verantwortlich, wenn er nicht mehr benötigt wird, indem er die CoTaskMemFree-Funktion aufruft . Informationen zu CoTaskMemFree finden Sie in der Dokumentation zum Windows SDK.

Rückgabewert

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

Rückgabecode	Beschreibung
E_POINTER	Der Parameter pRetVal ist NULL.
E_OUTOFMEMORY	Nicht genügend Arbeitsspeicher.
AUDCLNT_E_DEVICE_INVALIDATED	Das Audioendpunktgerät wurde getrennt, oder die Audiohardware oder die zugehörigen Hardwareressourcen wurden neu konfiguriert, deaktiviert, entfernt oder anderweitig für die Verwendung nicht verfügbar gemacht.
AUDCLNT_E_SERVICE_NOT_RUNNING	Der Windows-Audiodienst wird nicht ausgeführt.

Hinweise

Wenn der Client nicht IAudioSessionControl::SetDisplayName aufgerufen hat, um den Anzeigenamen festzulegen, ist die Zeichenfolge leer. Anstatt eine leere Namenszeichenfolge anzuzeigen, verwendet das Sndvol-Programm einen automatisch generierten Standardnamen, um die Lautstärkesteuerung für die Audiositzung zu bezeichnen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [Desktop-Apps | UWP-Apps]
Zielplattform	Windows
Kopfzeile	audiopolicy.h

Weitere Informationen

IAudioSessionControl-Schnittstelle

IAudioSessionControl::SetDisplayName