Metodo IKsJackDescription::GetJackDescription (devicetopology.h)

Il metodo GetJackDescription ottiene una descrizione di un jack audio.

Sintassi

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

Parametri

[in] nJack

Indice jack. Se la connessione è costituita da n jack, i jack vengono numerati da 0 a n- 1. Per ottenere il numero di jack, chiamare il metodo IKsJackDescription::GetJackCount .

[out] pDescription

Puntatore a un buffer allocato dal chiamante in cui il metodo scrive una struttura di tipo KSJACK_DESCRIPTION contenente informazioni sul jack. Le dimensioni del buffer devono essere almeno sizeof(KSJACK_DESCRIPTION).

Valore restituito

Se il metodo ha esito positivo, viene restituito S_OK. Se ha esito negativo, i codici restituiti possibili includono, ma non sono limitati a, i valori visualizzati nella tabella seguente.

Codice restituito Descrizione
E_INVALIDARG
Il parametro nJack non è un indice jack valido.
E_POINTER
Il puntatore pDescription è NULL.

Commenti

Quando un utente deve collegare un dispositivo endpoint audio a un jack o scollegarlo da un jack, un'applicazione audio può usare le informazioni descrittive recuperate da questo metodo per aiutare l'utente a trovare il jack. Sono incluse le informazioni seguenti:

  • Posizione fisica del jack sullo chassis del computer o della scatola esterna.
  • Colore del jack.
  • Tipo di connettore fisico usato per il jack.
  • Mapping dei canali al jack.
Per altre informazioni, vedere KSJACK_DESCRIPTION.

Requisiti

Requisito Valore
Client minimo supportato Windows Vista [solo app desktop]
Server minimo supportato Windows Server 2008 [solo app desktop]
Piattaforma di destinazione Windows
Intestazione devicetopology.h

Vedi anche

Interfaccia IKsJackDescription

IKsJackDescription::GetJackCount

KSJACK_DESCRIPTION