MÉTHODE IMMDevice::GetId (mmdeviceapi.h)

  • Article

La méthode GetId récupère une chaîne d’ID de point de terminaison qui identifie le périphérique de point de terminaison audio.

Syntaxe

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

Paramètres

[out] ppstrId

Pointeur vers une variable de pointeur dans laquelle la méthode écrit l’adresse d’une chaîne de caractères larges terminée par null contenant l’ID d’appareil de point de terminaison. La méthode alloue le stockage pour la chaîne. L’appelant est chargé de libérer le stockage, lorsqu’il n’est plus nécessaire, en appelant la fonction CoTaskMemFree . Si l’appel GetId échoue, *ppstrId a la valeur NULL. Pour plus d’informations sur CoTaskMemFree, consultez la documentation du Kit de développement logiciel (SDK) Windows.

Valeur retournée

Si la méthode réussit, retourne S_OK. En cas d’échec, les codes de retour possibles incluent, sans s’y limiter, les valeurs indiquées dans le tableau suivant.

Code de retour Description
E_OUTOFMEMORY
 Mémoire insuffisante.
E_POINTER
 Le paramètre pwstrId est NULL.

Notes

La chaîne d’ID de point de terminaison obtenue à partir de cette méthode identifie le périphérique de point de terminaison audio représenté par l’interface IMMDevice instance. Un client peut utiliser la chaîne d’ID de point de terminaison pour créer une instance du périphérique de point de terminaison audio ultérieurement ou dans un autre processus en appelant la méthode IMMDeviceEnumerator::GetDevice. Les clients doivent traiter le contenu de la chaîne d’ID de point de terminaison comme opaque. Autrement dit, les clients ne doivent pas essayer d’analyser le contenu de la chaîne pour obtenir des informations sur l’appareil. La raison en est que le format de chaîne n’est pas défini et peut changer d’une implémentation du module système d’API MMDevice à la suivante.

Pour obtenir des exemples de code qui appellent la méthode GetId , consultez les rubriques suivantes :

Spécifications

   
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
Plateforme cible Windows
En-tête mmdeviceapi.h

Voir aussi

IMMDevice, interface

IMMDeviceEnumerator::GetDevice