Microsoft Windows CE 3.0

HWPurgeComm

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function purges the communications device.

VOID HWPurgeComm(
PVOID
pContext, 
DWORD
fdwAction
);

Parameters

pContext

Pointer to a context structure returned by the HWInitfunction that contains implementation-specific data describing the hardware device.

fdwAction

One of the following values:

PURGE_TXABORT
PURGE_RXABORT
PURGE_TX_CLEAR
PURGE_RXCLEAR
Return Values

None.

Remarks

This function purges the serial device according to Win32 semantics for the following:
- PURGE_TXABORT
- PURGE_RXABORT
- PURGE_TXCLEAR
- PURGE_RXCLEAR
  This function is part of the implementation of the PDDs of serial port drivers.
  
  Requirements
  
  Runs on Versions Defined in Include Link to
  
  Windows CE OS 1.0 and later Serhw.h
  
  Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
  
  See Also
  
  HWInit
  
  Last updated on Tuesday, July 13, 2004
  
  © 2004 Microsoft Corporation. All rights reserved.