Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PurgeComm

Windows Mobile 6.5
A version of this page is also available for
4/8/2010

This function can discard 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(
  HANDLE hFile,
  DWORD dwFlags
);

hFile

[in] Handle to the communications resource.

The CreateFile function returns this handle.

dwFlags

[in] Specifies the action to take. The following table shows possible values.

Value Description

PURGE_RXABORT

Terminates outstanding overlapped read operations and returns immediately, even if the read operations have not been completed.

PURGE_RXCLEAR

Clears the input buffer, if the device driver has one.

PURGE_TXABORT

Terminates outstanding overlapped write operations and returns immediately, even if the write operations have not been completed.

PURGE_TXCLEAR

Clears the output buffer, if the device driver has one.

Nonzero indicates success. Zero indicates failure. To obtain extended error information, call the GetLastError function.

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).

FlushFileBuffers is subject to flow control but not to write timeouts, and it does not return until all pending write operations have been transmitted.

Headerwinbase.h
LibrarySerdev.lib
Windows Embedded CEWindows CE 1.0 and later
Windows MobileWindows Mobile Version 5.0 and later

Community Additions

Show:
© 2014 Microsoft