Xceed .NET Libraries Documentation
ReadItemData(Stream,Byte[],Int32,Int32) Method


Xceed.Zip Assembly > Xceed.Zip.ReaderWriter Namespace > ZipReader Class > ReadItemData Method : ReadItemData(Stream,Byte[],Int32,Int32) Method
A System.IO.Stream object that will receive the item's data.
An array of bytes to be used as the buffer in the data copy loop from ZipReader to stream.
The zero-based byte offset in buffer at which to begin copying bytes read.
The number of bytes to be copied to buffer in each loop iteration.
Reads the entire contents of the current item's data into a specified stream.
Syntax
'Declaration
 
Public Overloads Function ReadItemData( _

   ByVal stream As Stream, _

   ByVal buffer() As Byte, _

   ByVal offset As Integer, _

   ByVal count As Integer _

) As Long
'Usage
 
Dim instance As ZipReader

Dim stream As Stream

Dim buffer() As Byte

Dim offset As Integer

Dim count As Integer

Dim value As Long

 

value = instance.ReadItemData(stream, buffer, offset, count)
public long ReadItemData( 

   Stream stream,

   byte[] buffer,

   int offset,

   int count

)

Parameters

stream
A System.IO.Stream object that will receive the item's data.
buffer
An array of bytes to be used as the buffer in the data copy loop from ZipReader to stream.
offset
The zero-based byte offset in buffer at which to begin copying bytes read.
count
The number of bytes to be copied to buffer in each loop iteration.

Return Value

Returns the actual number of bytes written to the specified stream, or 0 if the end of the item's data has been reached.

Remarks

This method allows you to supply your own buffer for the loop that drives the copyoperation from ZipReader to the specified stream. It prevents ZipReader from allocating a temporary buffer to perform copy loop.

The specified stream must support writing. It is not necessary for the stream to support seeking or reading. The specified stream is written to using the specified buffer until the end of the item's data is reached. The method does not close specified stream.

An interesting use of this method is to use the System.IO.Steam.Null stream object. This will effectively skip an item's data and move ZipReader to the next item.

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

See Also

Reference

ZipReader Class
ZipReader Members
Overload List