Fonction WTSEnumerateListenersA (wtsapi32.h)

Article
03/04/2024

Énumère tous les écouteurs des services Bureau à distance sur un serveur hôte de session Bureau à distance (hôte de session Bureau à distance).

Syntaxe

BOOL WTSEnumerateListenersA(
  [in]            HANDLE            hServer,
  [in]            PVOID             pReserved,
  [in]            DWORD             Reserved,
  [out, optional] PWTSLISTENERNAMEA pListeners,
  [in, out]       DWORD             *pCount
);

Paramètres

[in] hServer

Handle vers un serveur hôte de session Bureau à distance. Définissez toujours ce paramètre sur WTS_CURRENT_SERVER_HANDLE.

[in] pReserved

Ce paramètre est réservé. Définissez toujours ce paramètre sur NULL.

[in] Reserved

Ce paramètre est réservé. Définissez toujours ce paramètre sur zéro.

[out, optional] pListeners

Pointeur vers un tableau de variables WTSLISTENERNAME qui reçoivent les noms des écouteurs.

[in, out] pCount

Pointeur vers une variable DWORD qui contient le nombre de noms d’écouteurs dans le tableau référencé par le paramètre pListeners . Si le nombre de noms d’écouteurs est inconnu, passez pListeners comme NULL. La fonction retourne le nombre de variables WTSLISTENERNAME nécessaires à allouer pour le tableau vers lequel pointe le paramètre pListeners .

Valeur retournée

Si la fonction réussit, la valeur de retour est une valeur différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Cette fonction retourne tous les écouteurs en cours d’exécution sur le serveur, y compris les écouteurs qui ne prennent pas en charge le protocole RDP (Remote Desktop Protocol).

Si le nombre d’écouteurs est inconnu, vous pouvez appeler cette fonction avec pListeners défini sur NULL. La fonction retourne ensuite, dans le paramètre pCount , le nombre de variables WTSLISTENERNAME nécessaires pour recevoir tous les écouteurs. Allouez le tableau pour pListeners en fonction de ce nombre, puis appelez à nouveau la fonction, en définissant pListeners sur le tableau nouvellement alloué et pCount sur le numéro retourné par le premier appel.

Notes

L’en-tête wtsapi32.h définit WTSEnumerateListeners 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 7
Serveur minimal pris en charge	Windows Server 2008 R2
Plateforme cible	Windows
En-tête	wtsapi32.h
Bibliothèque	Wtsapi32.lib
DLL	Wtsapi32.dll

Partager via