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

  • Artículo

El método GetId recupera una cadena de identificador de punto de conexión que identifica el dispositivo de punto de conexión de audio.

Sintaxis

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

Parámetros

[out] ppstrId

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 identificador de dispositivo del punto de conexión. 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 . Si se produce un error en la llamada a GetId , *ppstrId es NULL. 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 posibles códigos de retorno incluyen, pero no están limitados a, los valores que se muestran en la tabla siguiente.

Código devuelto Descripción
E_OUTOFMEMORY
 Memoria insuficiente
E_POINTER
 El parámetro pwstrId es NULL.

Comentarios

La cadena de identificador de punto de conexión obtenida de este método identifica el dispositivo de punto de conexión de audio representado por la instancia de interfaz IMMDevice . Un cliente puede usar la cadena de identificador de punto de conexión para crear una instancia del dispositivo de punto de conexión de audio más adelante o en un proceso diferente llamando al método IMMDeviceEnumerator::GetDevice . Los clientes deben tratar el contenido de la cadena de identificador de punto de conexión como opaco. Es decir, los clientes no deben intentar analizar el contenido de la cadena para obtener información sobre el dispositivo. El motivo es que el formato de cadena no está definido y podría cambiar de una implementación del módulo del sistema de API MMDevice al siguiente.

Para obtener ejemplos de código que llaman al método GetId , consulte los temas siguientes:

Requisitos

   
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado mmdeviceapi.h

Consulte también

IMMDevice (interfaz)

IMMDeviceEnumerator::GetDevice