Read Method (CompressingStream)

Reads data from the Stream and copies it into the provided buffer.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#
Managed Extensions for C++
C++/CLI

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

Dim instance As CompressingStream
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( 
   byte[]* buffer,
   int offset,
   int count
) override

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

Parameters

buffer: The storage location for the received data.
offset: The zero-based position in the buffer at which to store the received data.
count: The maximum number of bytes to read.

Return Value

The total number of bytes read into the buffer. A return value of 0 indicates no data is left to read.

Exceptions

Exception	Description
System.IO.IOException	Thrown when the Stream is not readable.
System.ArgumentNullException	Thrown when the buffer or callback is null.
System.ArgumentOutOfRangeException	Thrown when the offset is less than zero or when count is less than or equal to zero.
System.ArgumentException	Thrown when the (offset + count) > buffer.Length.

Remarks

This method copies bytes from the Stream to buffer, starting from the position specified by offset and reading up to the number of bytes specified by count.

Reference

CompressingStream Class
CompressingStream Members