Método IAudioSessionControl2::GetSessionIdentifier (audiopolicy.h)

O método GetSessionIdentifier recupera o identificador de sessão de áudio.

Sintaxe

HRESULT GetSessionIdentifier(
  [out] LPWSTR *pRetVal
);

Parâmetros

[out] pRetVal

Ponteiro para o endereço de uma cadeia de caracteres largos terminada em nulo que recebe o identificador de sessão de áudio. A cadeia de caracteres é alocada por esse método e deve ser liberada pelo chamador chamando 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.

Valor retornado	Descrição
E_POINTER	pRetVal é NULL.
AUDCLNT_E_DEVICE_INVALIDATED	A sessão de áudio é desconectada no dispositivo de áudio padrão.

Comentários

Cada sessão de áudio é identificada por uma cadeia de caracteres de identificador. Esta cadeia de caracteres do identificador de sessão não é exclusiva em todas as instâncias. Se houver duas instâncias do aplicativo em execução, ambas as instâncias terão o mesmo identificador de sessão. O identificador recuperado por GetSessionIdentifier é diferente do identificador da instância de sessão, que é exclusivo em todas as sessões. Para obter o identificador da instância de sessão, chame IAudioSessionControl2::GetSessionInstanceIdentifier.

GetSessionIdentifier verifica se a sessão foi desconectada no dispositivo padrão. Ele recupera a cadeia de caracteres do identificador armazenada em cache pelo cliente de áudio do dispositivo. Se o identificador de sessão não for encontrado, esse método o recuperará do mecanismo de áudio.

Requisitos

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

Confira também

IAudioSessionControl2