Xceed Real-Time Zip for .NET Documentation
Xceed.Zip Assembly / Xceed.Zip.ReaderWriter Namespace / ZipReader Class / ReadItemData Method / ReadItemData(Stream,Int32) Method
A System.IO.Stream object that will receive the item's data.
The number of bytes to be copied in each loop iteration.


In This Topic
    ReadItemData(Stream,Int32) Method
    In This Topic
    Reads the entire contents of an item's data into a specified stream.
    Syntax
    'Declaration
     
    Public Overloads Function ReadItemData( _
       ByVal stream As Stream, _
       ByVal bufferSize As Integer _
    ) As Long
    'Usage
     
    Dim instance As ZipReader
    Dim stream As Stream
    Dim bufferSize As Integer
    Dim value As Long
     
    value = instance.ReadItemData(stream, bufferSize)
    public long ReadItemData( 
       Stream stream,
       int bufferSize
    )

    Parameters

    stream
    A System.IO.Stream object that will receive the item's data.
    bufferSize
    The number of bytes to be copied 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 control the buffer size of the loop that drives the copy operation from the ZipReader object to the specified stream.

    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 size 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.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also