Método IKsJackDescription::GetJackDescription (devicetopology.h)

El método GetJackDescription obtiene una descripción de una toma de audio.

Sintaxis

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

Parámetros

[in] nJack

Índice jack. Si la conexión consta de n jacks, los conectores se numeran de 0 a n– 1. Para obtener el número de jacks, llame al método IKsJackDescription::GetJackCount .

[out] pDescription

Puntero a un búfer asignado por el autor de la llamada en el que el método escribe una estructura de tipo KSJACK_DESCRIPTION que contiene información sobre el conector. El tamaño del búfer debe ser al menos sizeof(KSJACK_DESCRIPTION).

Valor devuelto

Si el método se realiza correctamente, devuelve S_OK. Si se produce un error, los posibles códigos de retorno incluyen, pero no están limitados a, los valores que se muestran en la tabla siguiente.

Código devuelto	Descripción
E_INVALIDARG	El parámetro nJack no es un índice de jack válido.
E_POINTER	El puntero pDescription es NULL.

Comentarios

Cuando un usuario necesita conectar un dispositivo de punto de conexión de audio a un conector o desenchufarlo de un conector, una aplicación de audio puede usar la información descriptiva que recupera de este método para ayudar al usuario a encontrar el conector. Esta información incluye lo siguiente:

• Ubicación física del conector en el chasis del equipo o caja externa.
• Color del jack.
• Tipo de conector físico utilizado para el conector.
• Asignación de canales al conector.

Para obtener más información, consulte KSJACK_DESCRIPTION.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	devicetopology.h

Consulte también

IKsJackDescription (interfaz)

IKsJackDescription::GetJackCount

KSJACK_DESCRIPTION