Поделиться через

Метод IAudioSystemEffectsCustomFormats::GetFormatRepresentation (audioenginebaseapo.h)

  • Статья

Метод GetFormatRepresentation извлекает строковое представление настраиваемого формата, чтобы его можно было отобразить в пользовательском интерфейсе.

Синтаксис

HRESULT GetFormatRepresentation(
  [in]            UINT   nFormat,
  [out, optional] LPWSTR *ppwstrFormatRep
);

Параметры

[in] nFormat

Указывает индекс поддерживаемого формата. Этот параметр может быть любым значением в диапазоне от нуля до единицы меньше возвращаемого значения GetFormatCount. Иными словами, любое значение в диапазоне от нуля до GetFormatCount( ) — 1.

[out, optional] ppwstrFormatRep

Указывает адрес буфера, получающего строку Юникода с завершением NULL, описывающую пользовательский формат.

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

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

Код возврата Описание
E_POINTER
 Недопустимый указатель, переданный в функцию
E_OUTOFMEMORY
 Не удается выделить буфер возврата
E_INVALIDARG
 nFormat выходит за пределы диапазона

Комментарии

SAPO использует CoTaskMemAlloc для выделения возвращаемой строки. Вызывающий объект должен использовать CoTaskMemFree для удаления буфера, на который указывает параметр ppwstrFormatRep .

Требования

Требование Значение
Минимальная версия клиента Доступно в Windows Vista и более поздних версиях Windows.
Целевая платформа Персональный компьютер
Верхняя часть audioenginebaseapo.h (включая Audioenginebaseapo.h)
IRQL Все уровни.

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

CoTaskMemAlloc

CoTaskMemFree

GetFormatCount