Método IAudioSessionControl::GetDisplayName (audiopolicy.h)

El método GetDisplayName recupera el nombre para mostrar de la sesión de audio.

Sintaxis

HRESULT GetDisplayName(
  [out] LPWSTR *pRetVal
);

Parámetros

[out] pRetVal

Puntero a una variable de puntero en la que el método escribe la dirección de una cadena de caracteres anchos terminada en NULL que contiene el nombre para mostrar. El método asigna el almacenamiento para la cadena. El autor de la llamada es responsable de liberar el almacenamiento, cuando ya no es necesario, llamando a la función CoTaskMemFree . Para obtener información sobre CoTaskMemFree, consulte la documentación de Windows SDK.

Valor devuelto

Si el método se realiza correctamente, devuelve S_OK. Si se produce un error, los códigos de retorno posibles incluyen, entre otros, los valores que se muestran en la tabla siguiente.

Código devuelto	Descripción
E_POINTER	El parámetro pRetVal es NULL.
E_OUTOFMEMORY	Memoria insuficiente
AUDCLNT_E_DEVICE_INVALIDATED	El dispositivo de punto de conexión de audio se ha desconectado o el hardware de audio o los recursos de hardware asociados se han reconfigurado, deshabilitado, quitado o dejado de estar disponible para su uso.
AUDCLNT_E_SERVICE_NOT_RUNNING	El servicio de audio de Windows no se está ejecutando.

Comentarios

Si el cliente no ha llamado a IAudioSessionControl::SetDisplayName para establecer el nombre para mostrar, la cadena estará vacía. En lugar de mostrar una cadena de nombre vacía, el programa Sndvol usa un nombre predeterminado generado automáticamente para etiquetar el control de volumen de la sesión de audio.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [aplicaciones de escritorio | aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	audiopolicy.h

Consulte también

IAudioSessionControl (Interfaz)

IAudioSessionControl::SetDisplayName