Метод IKsFormatSupport::GetDevicePreferredFormat (devicetopology.h)

Метод GetDevicePreferredFormat получает предпочтительный формат аудиопотока для подключения.

Синтаксис

HRESULT GetDevicePreferredFormat(
  [out] PKSDATAFORMAT *ppKsFormat
);

Параметры

[out] ppKsFormat

Указатель на переменную указателя, в которую метод записывает адрес буфера, содержащего описатель формата для предпочтительного формата. Описатель начинается со структуры KSDATAFORMAT , за которой могут следовать дополнительные сведения о формате. Метод выделяет хранилище для описателя формата. Вызывающий объект отвечает за освобождение хранилища, когда оно больше не требуется, путем вызова функции CoTaskMemFree . Если метод завершается ошибкой, *ppKsFormat имеет значение NULL. Дополнительные сведения о KSDATAFORMAT, описателях формата и CoTaskMemFree см. в документации по Windows DDK.

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

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

Код возврата	Описание
E_POINTER	Pointer ppKsFormat имеет значение NULL.
E_OUTOFMEMORY	Недостаточно памяти.

Требования

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

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

Интерфейс IKsFormatSupport