ZipEngine Class
Engine capable of packing and unpacking archives in the zip format.
Methods
Section titled “Methods”| Method | Description |
|---|---|
| FindArchiveOffset(stream) | Gets the offset of an archive that is positioned 0 or more bytes from the start of the Stream. |
| IsArchive(stream) | Checks whether a Stream begins with a header that indicates it is a valid archive file. |
Properties
Section titled “Properties”| Property | Description |
|---|---|
| ArchiveComment | Gets the comment from the last-examined archive, or sets the comment to be added to any created archives. |
WixToolset.Dtf.Compression.Zip.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8 |
FindArchiveOffset(stream) Method
Section titled “FindArchiveOffset(stream) Method”Gets the offset of an archive that is positioned 0 or more bytes from the start of the Stream.
Declaration
Section titled “Declaration”public System.Int64 FindArchiveOffset( System.IO.Stream stream)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| stream | System.IO.Stream | A stream for reading the archive. |
Return value
Section titled “Return value”System.Int64 The offset in bytes of the archive, or -1 if no archive is found in the Stream.
Remarks
Section titled “Remarks”The archive must begin on a 4-byte boundary.
IsArchive(stream) Method
Section titled “IsArchive(stream) Method”Checks whether a Stream begins with a header that indicates it is a valid archive file.
Declaration
Section titled “Declaration”public bool IsArchive( System.IO.Stream stream)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| stream | System.IO.Stream | Stream for reading the archive file. |
Return value
Section titled “Return value”bool True if the stream is a valid zip archive (with no offset); false otherwise.
ArchiveComment Property
Section titled “ArchiveComment Property”Gets the comment from the last-examined archive, or sets the comment to be added to any created archives.
Declaration
Section titled “Declaration”public string ArchiveComment { get; set; }