ReadItemData(Stream) Method

Reads the entire contents of an item's data into a specified stream.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function ReadItemData( _

   ByVal stream As Stream _

) As Long

'Usage
 
Dim instance As ZipReader

Dim stream As Stream

Dim value As Long

 

value = instance.ReadItemData(stream)

public long ReadItemData( 

   Stream stream

)

Parameters

stream: A System.IO.Stream object that will receive the item's data.

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

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 a 64kb 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

Reference

ZipReader Class
ZipReader Members
Overload List