IAudioSessionControl::SetIconPath-Methode (audiopolicy.h)

Artikel
08/22/2023

Die SetIconPath-Methode weist der aktuellen Sitzung ein Anzeigesymbol zu.

Syntax

HRESULT SetIconPath(
  [in] LPCWSTR Value,
  [in] LPCGUID EventContext
);

Parameter

[in] Value

Zeiger auf eine Zeichenfolge mit NULL-Beendigung, die den Pfad und Dateinamen einer ICO-, .dll- oder .exe-Datei angibt, die das Symbol enthält. Informationen zu Symbolpfaden finden Sie in der Windows SDK-Dokumentation.

[in] EventContext

Zeiger auf die Ereigniskontext-GUID. Wenn ein Aufruf dieser Methode ein Symboländerungsereignis generiert, sendet der Sitzungs-Manager Benachrichtigungen an alle Clients, die IAudioSessionEvents-Schnittstellen mit dem Sitzungs-Manager registriert haben. Der Sitzungs-Manager enthält den EventContext-Zeigerwert mit jeder Benachrichtigung. Beim Empfang einer Benachrichtigung kann ein Client ermitteln, ob er oder ein anderer Client die Quelle des Ereignisses ist, indem er den EventContext-Wert überprüft. Dieses Schema hängt davon ab, dass der Client einen Wert für diesen Parameter auswählt, der für alle Clients in der Sitzung eindeutig ist. Wenn der Aufrufer einen NULL-Zeiger für diesen Parameter bereitstellt, empfängt die Benachrichtigungsmethode des Clients einen NULL-Kontextzeiger .

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	Der Parameterwert ist NULL.
AUDCLNT_E_DEVICE_INVALIDATED	Das Audioendpunktgerät wurde nicht angeschlossen, oder die Audiohardware oder die zugehörigen Hardwareressourcen wurden neu konfiguriert, deaktiviert, entfernt oder anderweitig nicht mehr verfügbar gemacht.
AUDCLNT_E_SERVICE_NOT_RUNNING	Der Windows-Audiodienst wird nicht ausgeführt.

Hinweise

In Windows Vista verwendet das vom System bereitgestellte Programm Sndvol.exe das Anzeigesymbol (zusammen mit dem Anzeigenamen), um die Lautstärkeregelung für die Sitzung zu bezeichnen. Wenn der Client SetIconPath nicht aufruft, um der Sitzung ein Symbol zuzuweisen, verwendet das Sndvol-Programm das Symbol aus dem Anwendungsfenster als Standardsymbol für die Sitzung.

Im Fall einer prozessübergreifenden Sitzung ist die Sitzung keinem einzelnen Anwendungsprozess zugeordnet. Daher verfügt Sndvol standardmäßig über kein anwendungsspezifisches Symbol, das verwendet werden kann, und der Client muss SetIconPath aufrufen, um zu vermeiden, dass ein bedeutungsloses Symbol angezeigt wird.

Das Anzeigesymbol bleibt nicht über die Lebensdauer des IAudioSessionControl-Objekts hinaus erhalten. Nachdem also alle Verweise auf das Objekt freigegeben wurden, verfügt eine anschließend erstellte Version des Objekts (mit derselben Anwendung, derselben Sitzungs-GUID und demselben Endpunktgerät) erneut über ein Standardsymbol, bis der Client SetIconPath aufruft.

Der Client kann das Anzeigesymbol für die Sitzung abrufen, indem er die IAudioSessionControl::GetIconPath-Methode aufruft .

Anforderungen


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::GetIconPath

Share via