Read Method (ArraySegmentStream)

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.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overrides Function Read( _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal count As Integer _
) As Integer

'Usage
 
Dim instance As ArraySegmentStream
Dim buffer() As Byte
Dim offset As Integer
Dim count As Integer
Dim value As Integer
 
value = instance.Read(buffer, offset, count)

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

public:
int Read( 
   array<byte>^ buffer,
   int offset,
   int count
) override

Parameters

buffer: 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: The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count: The maximum number of bytes to be read from the current stream.

Return Value

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	Description
System.ArgumentException	The sum of offset and count is larger than the buffer length.
System.ArgumentNullException	buffer is a null reference (Nothing in Visual Basic).
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.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ArraySegmentStream Class
ArraySegmentStream Members