Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SerialPort.Read Method (Char(), Int32, Int32)

Reads a number of characters from the SerialPort input buffer and writes them into an array of characters at a given offset.

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

'Declaration
Public Function Read ( _
	buffer As Char(), _
	offset As Integer, _
	count As Integer _
) As Integer

Parameters

buffer
Type: System.Char()

The character array to write the input to.

offset
Type: System.Int32

The offset in bufferat which to write the characters.

count
Type: System.Int32

The maximum number of characters to read. Fewer characters are read if count is greater than the number of characters in the input buffer.

Return Value

Type: System.Int32
The number of characters read.

ExceptionCondition
ArgumentException

offset plus count is greater than the length of the buffer.

- or -

count is 1 and there is a surrogate character in the buffer.

ArgumentNullException

The buffer passed is Nothing.

ArgumentOutOfRangeException

The offset or count parameters are outside a valid region of the buffer being passed. Either offset or count is less than zero.

InvalidOperationException

The specified port is not open.

TimeoutException

No characters were available to read.

Use this method for reading characters from the serial port.

If it is necessary to switch between reading text and reading binary data from the stream, select a protocol that carefully defines the boundary between text and binary data, such as manually reading bytes and decoding the data.

Because the SerialPort class buffers data, and the stream contained in the BaseStream property does not, the two might conflict about how many characters are available to read. The BytesToRead property can indicate that there are characters to read, but these characters might not be accessible to the stream contained in the BaseStream property because they have been buffered to the SerialPort class.

The Read method does not block other operations when the number of bytes read equals count but there are still unread bytes available on the serial port.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft