ComBreak
- Updated2023-02-21
- 1 minute(s) read
int ComBreak (int portNumber, int breakTime_msec);
Purpose
Generates a break signal.
A break signal is a communications signal that allows two communications devices to transmit a break signal in the transmission line. A break signal is the transmission of a special character on the communication line for a period longer than the transmission time for one character and its framing bits.
You can use a break signal to convey any special condition as long as the sender and receiver agree on the meaning.
ComBreak 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 |
| breakTime_msec | int | Specifies, in milliseconds, how long the break signal will be generated. For most applications, 250 ms is adequate. Default Value: 0 to select 250 ms. Valid Range: 1 to 2,147,483,647 |
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