Share via


HWPurgeComm

This function purges the communications device.

VOID HWPurgeComm(
  PVOID pContext,
  DWORD fdwAction 
);

Parameters

  • pContext
    [in] Pointer to a context structure returned by the HWInit function that contains implementation-specific data describing the hardware device.
  • fdwAction
    [in] Indicates how to purge the serial device. The following table shows the available flags.
    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.

Return Values

None.

Remarks

This function supports the implementation of the lower layers of serial port drivers.

Requirements

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

See Also

HWInit

 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.