StopBits Property

Sets and returns the stop bits communications parameter.

Syntax

Visual Basic

object.StopBits [ = value ]

Visual C++

object.GetStopBits()

object.SetStopBits(value)

Delphi

object.StopBits [ := value ]

Example

Visual Basic

'Set stop bits
myPortController.StopBits = 1

'Get stop bits
Dim stopBits As Integer
stopBits = myPortController.StopBits

Visual C++

// Set stop bits
m_myPortController.SetStopBits(1);

// Get stop bits
int stopBits = m_myPortController.GetStopBits();

Delphi

// Set stop bits
myPortController.StopBits := 1;

// Get stop bits
var stopBits: Integer;           // declare variable in the proper place.
stopBits := myPortController.StopBits;

Remarks

Note that the conventions for setting the stop bits value from the StopBits property and setting the stop bits value from the Open() method are slightly different.

Valid stop bits values are as follows:

Setting	Description
1	1 Stop Bit (Default)
15	1.5 Stop Bits
2	2 Stop Bits

Default

1

Returns

An integer representing the stop bits parameter of the port.

Errors

• Attempting to set StopBits to an invalid value will cause the PortController to throw an "Invalid argument" exception.

• Attempting to set StopBits to 1.5 when DataBits is 6, 7, or 8 is illegal and will cause the PortController to throw a "Invalid stop bits / data bits combination" exception if the port is open. If the port is closed, no exception will be thrown.

• Attempting to set StopBits to 2 when DataBits is 5 is illegal and will cause the PortController to throw a "Invalid stop bits / data bits combination" exception.

See Also