TCnSerialPort.Read(_ByteArray,Integer,Integer) Method
Reads a number of bytes from the SerialPort input buffer and writes those bytes into a byte array at the specified offset.
public function Read(Buffer: _ByteArray; Offset: Integer; Count: Integer): Integer; overload;
Parameters
- Buffer
- Type: _ByteArray
The byte array to write the input to.
- Offset
- Type: Integer
The offset in buffer at which to write the bytes.
- Count
- Type: Integer
The maximum number of bytes to read. Fewer bytes are read if count is greater than the number of bytes in the input buffer.
Return Value
The number of bytes read.
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 bytes are available to read. The BytesToRead property can indicate that there are bytes to read,
but these bytes 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.