IClientRead 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.218-beta

Syntax

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

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

int Read(
	array<unsigned char>^ buffer, 
	int startIndex, 
	int length
)

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

function Read(buffer, startIndex, length);

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.

Int32
The number of bytes read.

Remarks

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