This documentation is archived and is not being maintained.

SerialPort.WriteLine Method

Writes the specified string and the NewLine value to the output buffer.

Namespace:  System.IO.Ports
Assembly:  System (in System.dll)

public void WriteLine(
	string text
)

Parameters

text
Type: System.String

The string to write to the output buffer.

ExceptionCondition
ArgumentNullException

The str parameter is null.

InvalidOperationException

The specified port is not open.

TimeoutException

The WriteLine method could not write to the stream.

If there are too many bytes in the input buffer and Handshake is set to XOnXOff then the SerialPort object may raise a TimeoutException while it waits for the device to be ready to accept more data.

The written output includes the NewLine string.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0
Show: