Метод IControlInterface::GetName (devicetopology.h)

Метод GetName получает понятное имя звуковой функции, инкапсулируемой интерфейсом управления.

Синтаксис

HRESULT GetName(
  [out] LPWSTR *ppwstrName
);

Параметры

[out] ppwstrName

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

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

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

Код возврата	Описание
E_POINTER	Указатель ppwstrName имеет значение NULL.
E_OUTOFMEMORY	Недостаточно памяти.

Комментарии

В качестве примера понятного имени подсоединения с интерфейсом IAudioPeakMeter может иметь понятное имя "пиковый метр".

Требования

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

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

Интерфейс IAudioPeakMeter

Интерфейс IControlInterface