wclSerialClientHalPurgeComm Method

Implements a hardware-dependent code that discards 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.

Namespace: wclSerialFramework
Assembly: wclSerialFramework (in wclSerialFramework.dll) Version: 8.0.6.0

Syntax

C++

Copy

protected virtual int HalPurgeComm(
	wclSerialPurgeFlag Flags
)

Protected Overridable Function HalPurgeComm ( 
	Flags As wclSerialPurgeFlag
) As Integer

protected:
virtual int HalPurgeComm(
	wclSerialPurgeFlag Flags
)

Parameters

Flags wclSerialPurgeFlag: The set of the wclSerialPurgeFlag flags.

Return Value

Int32
If the method completed with success the return value is WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.

Reference

wclSerialClient Class

wclSerialFramework Namespace

wclSerialPurgeFlag

WCL_E_SUCCESS