Compartilhar via


Método IMMDevice::GetId (mmdeviceapi.h)

O método GetId recupera uma cadeia de caracteres de ID de ponto de extremidade que identifica o dispositivo de ponto de extremidade de áudio.

Sintaxe

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

Parâmetros

[out] ppstrId

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 a ID do dispositivo do ponto de extremidade. 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 GetId falhar, *ppstrId 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_OUTOFMEMORY
Sem memória.
E_POINTER
O parâmetro pwstrId é NULL.

Comentários

A cadeia de caracteres de ID do ponto de extremidade obtida desse método identifica o dispositivo de ponto de extremidade de áudio representado pela instância da interface IMMDevice . Um cliente pode usar a cadeia de caracteres de ID do ponto de extremidade para criar uma instância do dispositivo de ponto de extremidade de áudio posteriormente ou em um processo diferente chamando o método IMMDeviceEnumerator::GetDevice . Os clientes devem tratar o conteúdo da cadeia de caracteres de ID do ponto de extremidade como opaco. Ou seja, os clientes não devem tentar analisar o conteúdo da cadeia de caracteres para obter informações sobre o dispositivo. O motivo é que o formato de cadeia de caracteres é indefinido e pode mudar de uma implementação do módulo do sistema de API MMDevice para a próxima.

Para obter exemplos de código que chamam o método GetId , consulte os seguintes tópicos:

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 mmdeviceapi.h

Confira também

IMMDevice Interface

IMMDeviceEnumerator::GetDevice