Compartilhar via


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

O método GetDisplayName recupera o nome de exibição da sessão de áudio.

Sintaxe

HRESULT GetDisplayName(
  [out] LPWSTR *pRetVal
);

Parâmetros

[out] pRetVal

Ponteiro para uma variável de ponteiro na qual o método grava o endereço de uma cadeia de caracteres largos terminada em nulo que contém o nome de exibição. O método aloca o armazenamento para a cadeia de caracteres. O chamador é responsável por liberar o armazenamento, quando ele não é mais necessário, chamando a função CoTaskMemFree . Para obter informações sobre CoTaskMemFree, consulte a documentação do SDK do Windows.

Retornar valor

Se o método for bem-sucedido, retornará S_OK. Se falhar, os códigos de retorno possíveis incluem, mas não se limitam a, os valores mostrados na tabela a seguir.

Código de retorno Descrição
E_POINTER
O parâmetro pRetVal é NULL.
E_OUTOFMEMORY
Sem memória.
AUDCLNT_E_DEVICE_INVALIDATED
O dispositivo de ponto de extremidade de áudio foi desconectado ou o hardware de áudio ou os recursos de hardware associados foram reconfigurados, desabilitados, removidos ou não estão disponíveis para uso.
AUDCLNT_E_SERVICE_NOT_RUNNING
O serviço de áudio do Windows não está em execução.

Comentários

Se o cliente não tiver chamado IAudioSessionControl::SetDisplayName para definir o nome de exibição, a cadeia de caracteres estará vazia. Em vez de exibir uma cadeia de caracteres de nome vazia, o programa Sndvol usa um nome padrão gerado automaticamente para rotular o controle de volume para a sessão de áudio.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho audiopolicy.h

Confira também

IAudioSessionControl Interface

IAudioSessionControl::SetDisplayName