SerialClientRead Method

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Namespace: GSF.Communication
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.207-beta

Syntax

C++

JavaScript

Copy

public override int Read(
	byte[] buffer,
	int startIndex,
	int length
)

Public Overrides Function Read ( 
	buffer As Byte(),
	startIndex As Integer,
	length As Integer
) As Integer

public:
virtual int Read(
	array<unsigned char>^ buffer, 
	int startIndex, 
	int length
) override

abstract Read : 
        buffer : byte[] * 
        startIndex : int * 
        length : int -> int 
override Read : 
        buffer : byte[] * 
        startIndex : int * 
        length : int -> int

function Read(buffer, startIndex, length);

View Source

Parameters

buffer Byte: Destination buffer used to hold copied bytes.
startIndex Int32: 0-based starting index into destination buffer to begin writing data.
length Int32: The number of bytes to read from current received data buffer and write into buffer.

Return Value

Int32
The number of bytes read.

Implements

IClientRead(Byte, Int32, Int32)

Exceptions

Exception	Condition
InvalidOperationException	No received data buffer has been defined to read.
ArgumentNullException	buffer is null.
ArgumentOutOfRangeException	startIndex or length is less than 0 -or- startIndex and length will exceed buffer length.

Remarks

This function should only be called from within the ReceiveData event handler. Calling this method outside this event will have unexpected results.

Reference

SerialClient Class

GSF.Communication Namespace