StreamTools.ThreadSafeStream.Read Method

StreamTools ThreadSafeStream Read Method

NetworkComms.Net Help

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Namespace: NetworkCommsDotNet.Tools
Assembly: NetworkCommsDotNet (in NetworkCommsDotNet.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C++

Copy to Clipboard Print

public override int Read(
	byte[] buffer,
	int offset,
	int count
)

public override int Read(
	byte[] buffer,
	int offset,
	int count
)

Parameters

buffer: Type: System Byte
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset: Type: System Int32
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count: Type: System Int32
The maximum number of bytes to be read from the current stream.

Return Value

Type:

Int32
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Exceptions

Exception	Condition
System ArgumentException	The sum of offset and count is larger than the buffer length.
System ArgumentNullException	buffer is null.
System ArgumentOutOfRangeException	offset or count is negative.
System.IO IOException	An I/O error occurs.
System NotSupportedException	The stream does not support reading.
System ObjectDisposedException	Methods were called after the stream was closed.