ZipArchive.AddStream(String, Stream) Method

Creates a zip stream item and adds it to the archive.

Namespace: DevExpress.Compression

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public ZipStreamItem AddStream(
    string name,
    Stream stream
)

VB.NET

Public Function AddStream(
    name As String,
    stream As Stream
) As ZipStreamItem

Parameters

Name	Type	Description
name	String	A string that is the name of the newly created zip item.
stream	Stream	A Stream object containing data to add to the archive.

Returns

Type	Description
ZipStreamItem	A ZipStreamItem object that references the stream of data included in an archive.

Remarks

The AddStream method does not make a copy of original steam. For proper operation, you should ensure that the stream is not closed until the archive is saved using the ZipArchive.Save method. After the archive is saved, you have to close and dispose of the stream yourself.

View Example

ZipExamples.cs

using DevExpress.Compression;

public void ArchiveStream() {
    using (Stream myStream = new MemoryStream(System.Text.Encoding.UTF8.GetBytes("DevExpress"))) {
        using (Stream myZippedStream = new FileStream("ArchiveStream.zip", System.IO.FileMode.Create)) {
            using (ZipArchive archive = new ZipArchive()) {
                archive.AddStream("myStream", myStream);
                archive.Save(myZippedStream);
            }
        }
    }
}

ZipExamples.vb

Imports DevExpress.Compression

Public Sub ArchiveStream()
    Using myStream As Stream = New MemoryStream(System.Text.Encoding.UTF8.GetBytes("DevExpress"))
        Using myZippedStream As Stream = New FileStream("ArchiveStream.zip", System.IO.FileMode.Create)
            Using archive As New ZipArchive()
                archive.AddStream("myStream", myStream)
                archive.Save(myZippedStream)
            End Using
        End Using
    End Using
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddStream(String, Stream) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

zip-compression-and-archive-api-examples/CS/CompressionLibraryExamples/ZipExamples.cs#L159

using (ZipArchive archive = new ZipArchive()) {
    archive.AddStream("myStream", myStream);
    archive.Save(myZippedStream);

VB.NET

zip-compression-and-archive-api-examples/VB/CompressionLibraryExamples/ZipExamples.vb#L164

Using archive As New ZipArchive()
    archive.AddStream("myStream", myStream)
    archive.Save(myZippedStream)