Share via

Méthode IAudioSessionControl ::GetDisplayName (audiopolicy.h)

  • Article

La méthode GetDisplayName récupère le nom d’affichage de la session audio.

Syntaxe

HRESULT GetDisplayName(
  [out] LPWSTR *pRetVal
);

Paramètres

[out] pRetVal

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 qui contient le nom d’affichage. 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 . 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_POINTER
 Le paramètre pRetVal est NULL.
E_OUTOFMEMORY
 Mémoire insuffisante.
AUDCLNT_E_DEVICE_INVALIDATED
 Le périphérique de point de terminaison audio a été débranché, ou le matériel audio ou les ressources matérielles associées ont été reconfigurés, désactivés, supprimés ou autrement rendus indisponibles.
AUDCLNT_E_SERVICE_NOT_RUNNING
 Le service audio Windows n’est pas en cours d’exécution.

Remarques

Si le client n’a pas appelé IAudioSessionControl ::SetDisplayName pour définir le nom d’affichage, la chaîne est vide. Au lieu d’afficher une chaîne de nom vide, le programme Sndvol utilise un nom généré automatiquement par défaut pour étiqueter le contrôle de volume pour la session audio.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau | applications UWP]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau | applications UWP]
Plateforme cible Windows
En-tête audiopolicy.h

Voir aussi

IAudioSessionControl, interface

IAudioSessionControl ::SetDisplayName