GetCommMask, fonction (winbase.h)

Article
08/27/2023

Récupère la valeur du masque d’événement pour un appareil de communication spécifié.

Syntaxe

BOOL GetCommMask(
  [in]  HANDLE  hFile,
  [out] LPDWORD lpEvtMask
);

Paramètres

[in] hFile

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

[out] lpEvtMask

Pointeur vers la variable qui reçoit un masque d’événements actuellement activés. 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 de ligne s’est produite. Les erreurs de status de ligne sont CE_FRAME, CE_OVERRUN et CE_RXPARITY.
EV_EVENT1 0x0800	Un événement du premier type spécifique au fournisseur s’est produit.
EV_EVENT2 0x1000	Un événement du deuxième type spécifique au fournisseur s’est produit.
EV_PERR 0x0200	Une erreur d’imprimante s’est produite.
EV_RING 0x0100	Un indicateur de tonalité a été détecté.
EV_RLSD 0x0020	L’état du signal RLSD (receive-line-signal-detect) a changé d’état.
EV_RX80FULL 0x0400	La mémoire tampon de réception est pleine à 80 %.
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 GetCommMask utilise une variable de masque pour indiquer l’ensemble d’événements qui peuvent être surveillés pour une ressource de communication particulière. Un handle de 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 modifier le masque d’événement d’une ressource de communication, utilisez la fonction SetCommMask .

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