PurgeComm, fonction (winbase.h)

Article
08/27/2023

Ignore tous les caractères de la mémoire tampon de sortie ou d’entrée d’une ressource de communication spécifiée. Il peut également mettre fin aux opérations de lecture ou d’écriture en attente sur la ressource.

Syntaxe

BOOL PurgeComm(
  [in] HANDLE hFile,
  [in] DWORD  dwFlags
);

Paramètres

[in] hFile

Handle de la ressource de communication. La fonction CreateFile retourne ce handle.

[in] dwFlags

Ce paramètre peut prendre une ou plusieurs des valeurs suivantes.

Valeur	Signification
PURGE_RXABORT 0x0002	Met fin à toutes les opérations de lecture qui se chevauchent et retourne immédiatement, même si les opérations de lecture n’ont pas été effectuées.
PURGE_RXCLEAR 0x0008	Efface la mémoire tampon d’entrée (si le pilote de périphérique en a un).
PURGE_TXABORT 0x0001	Met fin à toutes les opérations d’écriture qui se chevauchent et retourne immédiatement, même si les opérations d’écriture n’ont pas été effectuées.
PURGE_TXCLEAR 0x0004	Efface la mémoire tampon de sortie (si le pilote de périphérique en a un).

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 thread utilise PurgeComm pour vider une mémoire tampon de sortie, les caractères supprimés ne sont pas transmis. Pour vider la mémoire tampon de sortie tout en vous assurant que le contenu est transmis, appelez la fonction FlushFileBuffers (une opération synchrone). Notez toutefois que FlushFileBuffers est soumis à un contrôle de flux, mais pas à des délais d’expiration d’écriture, et qu’il ne retourne pas tant que toutes les opérations d’écriture en attente n’auront pas été transmises.

Configuration requise


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

Voir aussi

Fonctions de communication

Ressources de communication

CreateFile

Partager via