Share via

HWPurgeComm (Windows Embedded CE 6.0)

  • Article

1/6/2010

This function purges the communications device.

Syntax

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

  • fdwAction
    [in] Indicates how to purge the serial device.

    The following table shows the possible 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 Value

None.

Remarks

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

Requirements

Header serhw.h
Windows Embedded CE Windows CE 1.0 and later

See Also

Reference

Serial Port Driver PDD Functions
HWInit