RasConnectionNotificationA, fonction (ras.h)

Article
11/20/2024

La fonction RasConnectionNotification spécifie un objet d’événement que le système définit à l’état signalé lorsqu’une connexion RAS est créée ou arrêtée.

Syntaxe

DWORD RasConnectionNotificationA(
  [in] HRASCONN unnamedParam1,
  [in] HANDLE   unnamedParam2,
  [in] DWORD    unnamedParam3
);

Paramètres

[in] unnamedParam1

Handle de la connexion RAS qui reçoit les notifications. Il peut s’agir d’un handle retourné par la fonction RasDial ou RasEnumConnections. Si ce paramètre est INVALID_HANDLE_VALUE, les notifications sont reçues pour toutes les connexions RAS sur le client local.

[in] unnamedParam2

Spécifie le handle d’un objet d’événement. Utilisez la fonction CreateEvent pour créer un objet d’événement.

[in] unnamedParam3

Spécifie l’événement RAS qui amène le système à signaler l’objet d’événement spécifié par le paramètre hEvent. Ce paramètre est une combinaison des valeurs suivantes.

Valeur	Signification
RASCN_Connection	Si hrasconn est INVALID_HANDLE_VALUE, hEvent est signalé lors de la création d’une connexion RAS.
RASCN_Disconnection	hEvent est signalé lorsque la connexion hrasconn est arrêtée. Si hrasconn est une connexion multilink, l’événement est signalé lorsque toutes les sous-entités sont déconnectées. Si hrasconn est INVALID_HANDLE_VALUE, l’événement est signalé lorsqu’une connexion RAS est arrêtée.
RASCN_BandwidthAdded	Windows NT : Si hrasconn est un handle vers une connexion multilink combinée, hEvent est signalé lorsqu’une sous-entrée est connectée.
RASCN_BandwidthRemoved	Windows NT : Si hrasconn est un handle vers une connexion multilink combinée, hEvent est signalé lorsqu’une sous-entrée est déconnectée.

Valeur de retour

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour est un code d’erreur non nul provenant de Codes d’erreur de routage et d’accès à distance ou Winerror.h.

Remarques

Pour déterminer quand l’objet d’événement est signalé, utilisez l’une des fonctions d’attente .

Lorsque l’événement est signalé, utilisez d’autres fonctions RAS, telles que RasEnumConnections, pour obtenir plus d’informations sur la connexion RAS créée ou arrêtée.

Note

L’en-tête ras.h définit RasConnectionNotification en tant qu’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 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	ras.h
bibliothèque	Rasapi32.lib
DLL	Rasapi32.dll

Voir aussi

CreateEvent

RasEnumConnections

Vue d’ensemble service d’accès à distance (RAS)

fonctions de service d’accès à distance

Partager via