# ComBreak

int ComBreak (int COMPort, int breakTimeMsec);

## 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
COMPort | integer | A number that indicates the COM port on which to operate. This number is paired with deviceName, which represents the COM port, during the OpenComConfig function call. Default Value: 1—COM1 Valid Range: 1—1,000
breakTimeMsec | integer | 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
result | integer | The result of this function call. This code is a negative value that specifies the type of error that occurred.