Fonction WTSEnumerateSessionsA (wtsapi32.h)

Article
03/04/2024

Récupère une liste de sessions sur un serveur hôte de session Bureau à distance (hôte de session Bureau à distance).

Syntaxe

BOOL WTSEnumerateSessionsA(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOA *ppSessionInfo,
  [out] DWORD              *pCount
);

Paramètres

[in] hServer

Handle pour le serveur hôte de session Bureau à distance.

Note Vous pouvez utiliser les fonctions WTSOpenServer ou WTSOpenServerEx pour récupérer un handle sur un serveur spécifique, ou WTS_CURRENT_SERVER_HANDLE utiliser le serveur hôte de session Bureau à distance qui héberge votre application.

[in] Reserved

Ce paramètre est réservé. Il doit être égal à zéro.

[in] Version

Version de la demande d’énumération. Ce paramètre doit être 1.

[out] ppSessionInfo

Pointeur vers un tableau de structures WTS_SESSION_INFO qui représentent les sessions récupérées. Pour libérer la mémoire tampon retournée, appelez la fonction WTSFreeMemory .

Autorisations de session :

Pour énumérer une session, vous devez activer l’autorisation d’informations de requête. Pour plus d’informations, consultez Autorisations des services Bureau à distance.
Pour modifier les autorisations sur une session, utilisez l’outil d’administration Configuration des services Bureau à distance.
Pour énumérer les sessions s’exécutant sur une machine virtuelle hébergée sur un serveur hôte de virtualisation des services Bureau à distance, vous devez être membre du groupe Administrateurs sur le serveur hôte de virtualisation des services Bureau à distance.

[out] pCount

Pointeur vers le nombre de structures WTS_SESSION_INFO retournées dans le paramètre ppSessionInfo .

Valeur retournée

Retourne zéro si cette fonction échoue. Si cette fonction réussit, une valeur différente de zéro est retournée.

Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Notes

L’en-tête wtsapi32.h définit WTSEnumerateSessions comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista
Serveur minimal pris en charge	Windows Server 2008
Plateforme cible	Windows
En-tête	wtsapi32.h
Bibliothèque	Wtsapi32.lib
DLL	Wtsapi32.dll
Ensemble d’API	ext-ms-win-session-wtsapi32-l1-1-0 (introduit dans Windows 8)

Voir aussi

WTS_SESSION_INFO

Partager via