SetCTSMode
- Updated2023-02-21
- 2 minute(s) read
int SetCTSMode (int portNumber, int hardwareHandshaking);
Purpose
Sets the hardware handshaking mode.
By default, hardware handshaking is not used.
When you enable hardware handshaking, the CTS line is monitored to determine when it is safe to send characters to the receiver. Also, the RTS line is raised only when there is space in the input queue to receive additional characters. Optionally, you can tie the DTR line to the RTS line.
SetCTSMode returns an error if you have not opened the port or if you pass an invalid parameter value.
Parameters
| Input | ||||||||||||||
| Name | Type | Description | ||||||||||||
| portNumber | int | A number that indicates the COM port on which to operate. This number maps to the COM port specified by deviceName in the call to OpenCom or OpenComConfig. The portNumber 1, for example, may not necessarily map to COM1. (Linux) The portNumber 1, for example, may not necessarily map to /dev/ttyS0. Valid Range: 1—1,000 |
||||||||||||
| hardwareHandshaking | int | The hardware handshaking mode for the selected port. Use hardware handshaking to control the flow of data between the sender and receiver so that the receiver's input buffer does not overflow.
|
||||||||||||
Return Value
| Name | Type | Description |
| returnValue | int | The result of this function call. This code is a negative value that specifies the type of error that occurred. |
Additional Information
Library: RS-232 Library
Include file: rs232.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Examples
Refer to the following examples that use the SetCTSMode function:
- rs232\commcallback.cws
Open example - rs232\serial.cws
Open example