PurgeComm function (winbase.h)
Discards all characters from the output or input buffer of a specified communications resource. It can also terminate pending read or write operations on the resource.
BOOL PurgeComm( [in] HANDLE hFile, [in] DWORD dwFlags );
A handle to the communications resource. The CreateFile function returns this handle.
This parameter can be one or more of the following values.
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
If a thread uses PurgeComm to flush an output buffer, the deleted characters are not transmitted. To empty the output buffer while ensuring that the contents are transmitted, call the FlushFileBuffers function (a synchronous operation). Note, however, that FlushFileBuffers is subject to flow control but not to write time-outs, and it will not return until all pending write operations have been transmitted.
|Minimum supported client||Windows XP [desktop apps | UWP apps]|
|Minimum supported server||Windows Server 2003 [desktop apps | UWP apps]|
|Header||winbase.h (include Windows.h)|