SPORT_PEEK_LINE (W*32, W*64)

Serial Port I/O Function: Returns information about the availability of input records.

Module: USE IFPORT

Syntax

result = SPORT_PEEK_LINE (port [, present] [, count])

port
(Input) Integer. The port number.

present
(Output; optional) Integer. 1 if data is present, 0 if no data has been read.

count
(Output; optional) Integer. The count of characters that will be returned by SPORT_READ_DATA.

Results

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

This routine will only return when a line terminator has been seen - as defined by the mode specified in the SPORT_CONNECT( ) call.

Note

CR and LF characters may not be returned depending on the mode specified in the SPORT_CONNECT( ) call.

Compatibility

CONSOLE STANDARD GRAPHICS QUICKWIN GRAPHICS WINDOWS DLL LIB

See Also

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

Example

USE IFPORT
INTEGER(4) iresult
INTEGER    present
INTEGER    count

iresult =  SPORT_PEEK_LINE( 2, present, count )
END