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

Метод IAudioSessionControl::GetDisplayName (audiopolicy.h)

  • Статья

Метод GetDisplayName получает отображаемое имя звукового сеанса.

Синтаксис

HRESULT GetDisplayName(
  [out] LPWSTR *pRetVal
);

Параметры

[out] pRetVal

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

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

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

Код возврата Описание
E_POINTER
 Параметр pRetVal имеет значение NULL.
E_OUTOFMEMORY
 Недостаточно памяти.
AUDCLNT_E_DEVICE_INVALIDATED
 Устройство конечной точки аудио отключено, звуковое оборудование или связанные аппаратные ресурсы были перенастроены, отключены, удалены или иным образом недоступны для использования.
AUDCLNT_E_SERVICE_NOT_RUNNING
 Служба звука Windows не запущена.

Комментарии

Если клиент не вызвал IAudioSessionControl::SetDisplayName для задания отображаемого имени, строка будет пустой. Вместо отображения пустой строки имени программа Sndvol использует автоматически созданное по умолчанию имя для маркировки элемента управления громкости для звукового сеанса.

Требования

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

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

Интерфейс IAudioSessionControl

IAudioSessionControl::SetDisplayName