Método IControlInterface::GetName (devicetopology.h)

O método GetName obtém o nome amigável para a função de áudio encapsulada pela interface de controle.

Sintaxe

HRESULT GetName(
  [out] LPWSTR *ppwstrName
);

Parâmetros

[out] ppwstrName

Ponteiro para um ponteiro de cadeia de caracteres no qual o método grava o endereço de uma cadeia de caracteres largos terminada em nulo que contém o nome amigável. 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 . Se a chamada GetName falhar, *ppwstrName será NULL. Para obter informações sobre CoTaskMemFree, consulte a documentação do SDK do Windows.

Valor retornado

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 ponteiro ppwstrName é NULL.
E_OUTOFMEMORY
Sem memória.

Comentários

Como exemplo de um nome amigável, uma subunidade com uma interface IAudioPeakMeter pode ter o nome amigável "peak meter".

Requisitos

   
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho devicetopology.h

Confira também

IAudioPeakMeter Interface

IControlInterface Interface