TCnSerialPort.Read(_CharArray,Integer,Integer) Method

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

Namespace: CNClrLib.Component.SerialPort
public
 function Read(Buffer: _CharArray; Offset: Integer; Count: Integer): Integer; overload;

Parameters

Buffer
Type: _CharArray

The character array to write the input to.

Offset
Type: Integer

The offset in buffer at which to write the characters.

Count
Type: Integer

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: Integer

The number of characters 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 TCnSerialPort 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 TCnSerialPort 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.