Developer Guide and Reference

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

SPORT_SET_STATE

Serial Port I/O Function: Sets the baud rate, parity, data bits setting, and stop bits setting of the communications port. This routine is only available for Windows.

Module

USE IFPORT

result = SPORT_SET_STATE (port [,baud] [,parity] [,dbits] [,sbits])

port

(Input) Integer. The port number.

baud

(Input; optional) Integer. The baud rate of the port.

parity

(Input; optional) Integer. The parity setting of the port (0-4 = no, odd, even, mark, space).

dbits

(Input; optional) Integer. The data bits for the port.

sbits

(Input; optional) Integer. The stop bits for the port (0, 1, 2 = 1, 1.5, 2).

Results

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

The following restrictions apply:

  • The number of data bits must be 5 to 8 bits.

  • The use of 5 data bits with 2 stop bits is an invalid combination, as is 6, 7, or 8 data bits with 1.5 stop bits.

NOTE:

This routine must not be used when any I/O is pending. Since a read operation is always pending after any I/O has been started, you must first call SPORT_CANCEL_IO before port parameters can be changed.

Example

USE IFPORT
INTEGER(4) iresult
iresult =  SPORT_SET_STATE( 2, 9600, 0, 7, 0 )
END

See Also