IServerRead 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

C++

JavaScript

Copy

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

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

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

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

function Read(clientID, buffer, startIndex, length);

Parameters

clientID Guid: ID of the client from which data buffer should be read.
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.

Remarks

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

Reference

IServer Interface

GSF.Communication Namespace