IControlInterface::GetName-Methode (devicetopology.h)

Die GetName-Methode ruft den Anzeigenamen für die Audiofunktion ab, die von der Steuerungsschnittstelle gekapselt wird.

Syntax

HRESULT GetName(
  [out] LPWSTR *ppwstrName
);

Parameter

[out] ppwstrName

Zeiger auf einen Zeichenfolgenzeiger, in den 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 . Wenn der GetName-Aufruf fehlschlägt, ist *ppwstrNameNULL. 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 Zeiger ppwstrName ist NULL.
E_OUTOFMEMORY
Nicht genügend Arbeitsspeicher.

Hinweise

Als Beispiel für einen Anzeigenamen kann eine Untereinheit mit einer IAudioPeakMeter-Schnittstelle den Anzeigenamen "peak meter" aufweisen.

Anforderungen

   
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

IAudioPeakMeter-Schnittstelle

IControlInterface-Schnittstelle