Share via


IKsJackDescription::GetJackDescription-Methode (devicetopology.h)

Die GetJackDescription-Methode ruft eine Beschreibung einer Audiobuchse ab.

Syntax

HRESULT GetJackDescription(
  [in]  UINT               nJack,
  [out] KSJACK_DESCRIPTION *pDescription
);

Parameter

[in] nJack

Der Jack-Index. Wenn die Verbindung aus n Buchsen besteht, werden die Buchsen zwischen 0 und n– 1 nummeriert. Rufen Sie die IKsJackDescription::GetJackCount-Methode auf, um die Anzahl der Buchsen abzurufen.

[out] pDescription

Zeiger auf einen vom Aufrufer zugeordneten Puffer, in den die Methode eine Struktur vom Typ KSJACK_DESCRIPTION schreibt, die Informationen über die Buchse enthält. Die Puffergröße muss mindestens sizeof(KSJACK_DESCRIPTION) sein.

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_INVALIDARG
Parameter nJack ist kein gültiger Jack-Index.
E_POINTER
Zeiger pDescription ist NULL.

Hinweise

Wenn ein Benutzer ein Audioendpunktgerät an eine Buchse anschließen oder es von einer Buchse trennen muss, kann eine Audioanwendung die beschreibenden Informationen verwenden, die sie von dieser Methode abruft, um den Benutzer bei der Suche nach der Buchse zu unterstützen. Folgende Informationen werden erfasst:

  • Die physische Position der Buchse auf dem Computergehäuse oder der externen Box.
  • Die Farbe der Buchse.
  • Der Typ des physischen Connectors, der für die Buchse verwendet wird.
  • Die Zuordnung von Kanälen zur Buchse.
Weitere Informationen finden Sie unter KSJACK_DESCRIPTION.

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

IKsJackDescription-Schnittstelle

IKsJackDescription::GetJackCount

KSJACK_DESCRIPTION