Fonction ClearCommError (winbase.h)

Article
08/27/2023

Récupère des informations sur une erreur de communication et signale la status actuelle d’un appareil de communication. La fonction est appelée lorsqu’une erreur de communication se produit, et elle efface l’indicateur d’erreur de l’appareil pour activer des opérations d’entrée et de sortie (E/S) supplémentaires.

Syntaxe

BOOL ClearCommError(
  [in]            HANDLE    hFile,
  [out, optional] LPDWORD   lpErrors,
  [out, optional] LPCOMSTAT lpStat
);

Paramètres

[in] hFile

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

[out, optional] lpErrors

Pointeur vers une variable qui reçoit un masque indiquant le type d’erreur. Ce paramètre peut prendre une ou plusieurs des valeurs suivantes.

Valeur	Signification
CE_BREAK 0x0010	Le matériel a détecté une condition d’arrêt.
CE_FRAME 0x0008	Le matériel a détecté une erreur de trame.
CE_OVERRUN 0x0002	Un dépassement de mémoire tampon de caractères s’est produit. Le caractère suivant est perdu.
CE_RXOVER 0x0001	Un dépassement de la mémoire tampon d’entrée s’est produit. Il n’y a plus de place dans la mémoire tampon d’entrée ou un caractère a été reçu après le caractère de fin de fichier.
CE_RXPARITY 0x0004	Le matériel a détecté une erreur de parité.

Les valeurs suivantes ne sont pas prises en charge :

[out, optional] lpStat

Pointeur vers une structure COMSTAT dans laquelle les informations status de l’appareil sont retournées. Si ce paramètre a la valeur NULL, aucune information status n’est retournée.

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

Si un port de communication a été configuré avec une valeur TRUE pour le membre fAbortOnError de la structure DCB d’installation, le logiciel de communication met fin à toutes les opérations de lecture et d’écriture sur le port de communication en cas d’erreur de communication. Aucune nouvelle opération de lecture ou d’écriture ne sera acceptée tant que l’application n’aura pas reconnu l’erreur de communication en appelant la fonction ClearCommError .

La fonction ClearCommError remplit la mémoire tampon status pointée par le paramètre lpStat avec la status actuelle de l’appareil de communication spécifié par le paramètre hFile.

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