Méthode IAudioSessionControl2 ::GetSessionIdentifier (audiopolicy.h)

La méthode GetSessionIdentifier récupère l’identificateur de session audio.

Syntaxe

HRESULT GetSessionIdentifier(
  [out] LPWSTR *pRetVal
);

Paramètres

[out] pRetVal

Pointeur vers l’adresse d’une chaîne de caractères larges terminée par null qui reçoit l’identificateur de session audio. La chaîne est allouée par cette méthode et doit être libérée par l’appelant en appelant 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.

Valeur retournée	Description
E_POINTER	pRetVal a la valeur NULL.
AUDCLNT_E_DEVICE_INVALIDATED	La session audio est déconnectée sur le périphérique audio par défaut.

Remarques

Chaque session audio est identifiée par une chaîne d’identificateur. Cette chaîne d’identificateur de session n’est pas unique pour toutes les instances. S’il existe deux instances de l’application lue, les deux instances auront le même identificateur de session. L’identificateur récupéré par GetSessionIdentifier est différent de l’identificateur de session instance, qui est unique pour toutes les sessions. Pour obtenir l’identificateur instance de session, appelez IAudioSessionControl2 ::GetSessionInstanceIdentifier.

GetSessionIdentifier vérifie si la session a été déconnectée sur l’appareil par défaut. Il récupère la chaîne d’identificateur mise en cache par le client audio pour l’appareil. Si l’identificateur de session est introuvable, cette méthode le récupère à partir du moteur audio.

Configuration requise

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

Voir aussi

IAudioSessionControl2