Metodo IMMDevice::GetId (mmdeviceapi.h)

Il metodo GetId recupera una stringa ID endpoint che identifica il dispositivo dell'endpoint audio.

Sintassi

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

Parametri

[out] ppstrId

Puntatore a una variabile puntatore in cui il metodo scrive l'indirizzo di una stringa di caratteri null con terminazione null contenente l'ID dispositivo endpoint. Il metodo alloca l'archiviazione per la stringa. Il chiamante è responsabile della liberazione dell'archiviazione, quando non è più necessario, chiamando la funzione CoTaskMemFree . Se la chiamata GetId ha esito negativo, *ppstrId è NULL. Per informazioni su CoTaskMemFree, vedere la documentazione di Windows SDK.

Valore restituito

Se il metodo ha esito positivo, viene restituito S_OK. Se ha esito negativo, i codici restituiti possibili includono, ma non sono limitati a, i valori visualizzati nella tabella seguente.

Codice restituito Descrizione
E_OUTOFMEMORY
Memoria insufficiente.
E_POINTER
Il parametro pwstrId è NULL.

Commenti

La stringa ID endpoint ottenuta da questo metodo identifica il dispositivo dell'endpoint audio rappresentato dall'istanza dell'interfaccia IMMDevice . Un client può usare la stringa ID endpoint per creare un'istanza del dispositivo endpoint audio in un secondo momento o in un processo diverso chiamando il metodo IMMDeviceEnumerator::GetDevice . I client devono considerare il contenuto della stringa ID dell'endpoint come opaca. Vale a dire, i client non devono tentare di analizzare il contenuto della stringa per ottenere informazioni sul dispositivo. Il motivo è che il formato stringa non è definito e potrebbe cambiare da un'implementazione del modulo di sistema API MMDevice al successivo.

Per esempi di codice che chiamano il metodo GetId , vedere gli argomenti seguenti:

Requisiti

   
Client minimo supportato Windows Vista [solo app desktop]
Server minimo supportato Windows Server 2008 [solo app desktop]
Piattaforma di destinazione Windows
Intestazione mmdeviceapi.h

Vedi anche

Interfaccia IMMDevice

IMMDeviceEnumerator::GetDevice