Метод IKsJackDescription::GetJackDescription (devicetopology.h)

Статья
08/23/2023

Метод GetJackDescription получает описание аудиоразъема.

Синтаксис

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

Параметры

[in] nJack

Индекс джека. Если соединение состоит из n разъемов, разъемы нумеруются от 0 до n–1. Чтобы получить количество разъемов, вызовите метод IKsJackDescription::GetJackCount .

[out] pDescription

Указатель на буфер, выделенный вызывающим объектом, в который метод записывает структуру типа KSJACK_DESCRIPTION , содержащую сведения о разъеме. Размер буфера должен быть не ниже sizeof(KSJACK_DESCRIPTION).

Возвращаемое значение

Если метод завершается успешно, возвращает значение S_OK. В случае сбоя возможные коды возврата включают, но не ограничиваются ими, значения, показанные в следующей таблице.

Код возврата	Описание
E_INVALIDARG	Параметр nJack не является допустимым индексом jack.
E_POINTER	Указатель pDescription имеет значение NULL.

Когда пользователю необходимо подключить устройство конечной точки звука к разъему или отключить его от разъема, звуковое приложение может использовать описательные сведения, полученные из этого метода, чтобы помочь пользователю найти разъем. Эти данные включают:

Физическое расположение разъема на корпусе компьютера или внешней коробке.
Цвет гнезда.
Тип физического соединителя, используемого для разъема.
Сопоставление каналов с разъемом.

Дополнительные сведения см. в разделе KSJACK_DESCRIPTION.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	devicetopology.h

См. также раздел

Интерфейс IKsJackDescription

IKsJackDescription::GetJackCount

KSJACK_DESCRIPTION

Share via