WTSCreateListenerA, fonction (wtsapi32.h)

Article
11/20/2024

Crée un écouteur des services Bureau à distance ou configure un écouteur existant.

Syntaxe

BOOL WTSCreateListenerA(
  [in] HANDLE              hServer,
  [in] PVOID               pReserved,
  [in] DWORD               Reserved,
  [in] LPSTR               pListenerName,
  [in] PWTSLISTENERCONFIGA pBuffer,
  [in] DWORD               flag
);

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.

[in] pListenerName

Pointeur vers une chaîne terminée par null qui contient le nom de l’écouteur à créer ou configurer.

[in] pBuffer

Pointeur vers une structure WTSLISTENERCONFIG qui contient des informations de configuration pour l’écouteur.

[in] flag

Objectif de l’appel. Ce paramètre peut être l’une des valeurs suivantes.

WTS_LISTENER_CREATE (1 (0x1))

Créez un écouteur.

WTS_LISTENER_UPDATE (16 (0x10))

Mettez à jour les paramètres d’un écouteur existant.

Valeur de retour

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’erreur étendues, appelez la fonction GetLastError.

Remarques

Cette fonction crée ou configure un écouteur qui utilise protocole RDP (Remote Desktop Protocol). Définissez toujours la version membre de la structure WTSLISTENERCONFIG pointée par le paramètre pBuffer sur un.

Cette fonction ne crée pas ou ne configure pas le descripteur de sécurité de l’écouteur. Lorsque vous appelez cette fonction pour créer un écouteur, la fonction affecte le descripteur de sécurité par défaut au nouvel écouteur. Pour modifier le descripteur de sécurité, appelez la fonction WTSSetListenerSecurity. Pour plus d’informations sur les descripteurs de sécurité, consultez SECURITY_DESCRIPTOR.

Cette fonction ne valide pas les paramètres du nouvel écouteur. Vérifiez que les paramètres sont valides avant d’appeler cette fonction.

Note

L’en-tête wtsapi32.h définit WTSCreateListener comme 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 7
serveur minimum pris en charge	Windows Server 2008 R2
plateforme cible	Windows
d’en-tête	wtsapi32.h
bibliothèque	Wtsapi32.lib
DLL	Wtsapi32.dll