SPORT_PURGE (W*32, W*64)

Serial Port I/O Function: Executes the Windows* API communications function PurgeComm on the specified port.

Module: USE IFPORT

Syntax

result = SPORT_PURGE (port, function)

port
(Input) Integer. The port number.


function
(Input) INTEGER(4). The function for PurgeComm (see the Windows documentation).

Results

The result type is INTEGER(4). The result is zero if successful; otherwise, a Windows error value.

Compatibility

CONSOLE STANDARD GRAPHICS QUICKWIN GRAPHICS WINDOWS DLL LIB

See Also

Communications and Communications Functions in the Microsoft* Platform SDK, Building Applications: Using the Serial I/O Port Routines

Example

USE IFWINTY
USE IFPORT
INTEGER(4) iresult
iresult =  SPORT_PURGE( 2, (PURGE_TXABORT .or. PURGE_RXABORT) )
END