Developer Guide and Reference

ID 767251
Date 10/31/2024
Public
Document Table of Contents

SPORT_PEEK_DATA

Serial Port I/O Function: Returns information about the availability of input data. This routine is only available for Windows.

Module

USE IFPORT

result = SPORT_PEEK_DATA (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.

NOTE:

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

Example

USE IFPORT
INTEGER(4) iresult
INTEGER    present
INTEGER    count

iresult =  SPORT_PEEK_DATA( 2, present, count )
END

See Also