SetCommMask, fonction (winbase.h)

Article
03/06/2024

Spécifie un ensemble d’événements à surveiller pour un appareil de communication.

Syntaxe

BOOL SetCommMask(
  [in] HANDLE hFile,
  [in] DWORD  dwEvtMask
);

Paramètres

[in] hFile

Handle de l’appareil de communication. La fonction CreateFile retourne ce handle.

[in] dwEvtMask

Événements à activer. La valeur zéro désactive tous les événements. Ce paramètre peut prendre une ou plusieurs des valeurs suivantes.

Valeur	Signification
EV_BREAK 0x0040	Un arrêt a été détecté sur l'entrée.
EV_CTS 0x0008	Le signal CTS (clear-to-send) a changé d’état.
EV_DSR 0x0010	Le signal DSR (data-set-ready) a changé d’état.
EV_ERR 0x0080	Une erreur de status ligne s’est produite. Les erreurs de status de ligne sont CE_FRAME, CE_OVERRUN et CE_RXPARITY.
EV_RING 0x0100	Un indicateur de tonalité a été détecté.
EV_RLSD 0x0020	Le signal RLSD (receive-line-signal-detect) a changé d’état.
EV_RXCHAR 0x0001	Un caractère a été reçu et placé dans la mémoire tampon d’entrée.
EV_RXFLAG 0x0002	Le caractère d’événement a été reçu et placé dans la mémoire tampon d’entrée. Le caractère d’événement est spécifié dans la structure DCB de l’appareil, qui est appliquée à un port série à l’aide de la fonction SetCommState .
EV_TXEMPTY 0x0004	Le dernier caractère de la mémoire tampon de sortie a été envoyé.

Valeur retournée

Si la fonction réussit, la valeur de retour est 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

La fonction SetCommMask spécifie l’ensemble d’événements pouvant être surveillés pour une ressource de communication particulière. Un handle pour la ressource de communication peut être spécifié dans un appel à la fonction WaitCommEvent , qui attend que l’un des événements se produise. Pour obtenir le masque d’événement actuel d’une ressource de communication, utilisez la fonction GetCommMask .

Exemples

Pour obtenir un exemple, consultez Surveillance des événements de communication.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	winbase.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll