IMMDevice::GetId-Methode (mmdeviceapi.h)

  • Artikel

Die GetId-Methode ruft eine Endpunkt-ID-Zeichenfolge ab, die das Audioendpunktgerät identifiziert.

Syntax

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

Parameter

[out] ppstrId

Zeiger auf eine Zeigervariable, in die die -Methode die Adresse einer mit NULL beendeten breitzeichenigen Zeichenfolge schreibt, die die Geräte-ID des Endpunkts 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 GetId-Aufruf fehlschlägt, ist *ppstrId NULL. 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_OUTOFMEMORY
 Nicht genügend Arbeitsspeicher.
E_POINTER
 Der Parameter pwstrId ist NULL.

Hinweise

Die von dieser Methode abgerufene Endpunkt-ID-Zeichenfolge identifiziert das Audioendpunktgerät, das durch die IMMDevice-Schnittstelle instance dargestellt wird. Ein Client kann die Endpunkt-ID verwenden, um eine instance des Audioendpunktgeräts zu einem späteren Zeitpunkt oder in einem anderen Prozess zu erstellen, indem er die IMMDeviceEnumerator::GetDevice-Methode aufruft. Clients sollten den Inhalt der Endpunkt-ID-Zeichenfolge als undurchsichtig behandeln. Das heißt, Clients sollten nicht versuchen, den Inhalt der Zeichenfolge zu analysieren, um Informationen über das Gerät abzurufen. Der Grund ist, dass das Zeichenfolgenformat nicht definiert ist und sich möglicherweise von einer Implementierung des MMDevice-API-Systemmoduls zur nächsten ändert.

Codebeispiele, die die GetId-Methode aufrufen, finden Sie in den folgenden Themen:

Anforderungen

   
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile mmdeviceapi.h

Weitere Informationen

IMMDevice-Schnittstelle

IMMDeviceEnumerator::GetDevice