IOCTL_SERIAL_PURGE

This IOCTL discards characters from the output or input buffer of a specified communications resource. It can also terminate pending read or write operations on the resource.

Parameters

  • dwOpenData
    [in] Specifies the handle returned from a call to the COM_Open function.

  • dwCode
    [in] Specifies this code.

  • pBufIn
    [in] Pointer to a DWORD. The following table shows the flags that this DWORD contains.

    Flag Description
    PURGE_TXABORT Terminates all outstanding write operations and returns immediately, even if the write operations have not been completed.
    PURGE_RXABORT Terminates all outstanding read operations and returns immediately, even if the read operations have not been completed.
    PURGE_TXCLEAR Clears the output buffer if the driver has one.
    PURGE_RXCLEAR Clears the input buffer if the driver has one.
  • dwLenIn
    [in] Specifies the size of a DWORD.

  • pBufOut
    Ignored.

  • dwLenOut
    Ignored.

  • pdwActualOut
    Ignored.

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Pegdser.h.

See Also

COM_IOControl | COM_Open

 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.