| Dart.PowerTCP.Zip Namespace > Archive Class > Zip Method : Zip(Stream) Method |
<DescriptionAttribute("To compress the current collection to a stream")> Public Overloads Sub Zip( _ ByVal destination As Stream _ )
[Description("To compress the current collection to a stream")] public void Zip( Stream destination )
[Description("To compress the current collection to a stream")] public: void Zip( Stream* destination )
[Description("To compress the current collection to a stream")] public: void Zip( Stream^ destination )
| Exception | Description |
|---|---|
| ZipException | A critical zip operation error occurred during this activity. Please see ZipException.Message for details. |
The Archive.Password and Archive.Encryption properties are used for data encryption during the Zip operation. The Archive.PreservePath property determines whether to preserve paths for each file item. The Archive.IncludeSubs property determines whether to include the subdirectories. The Archive.ExcludePattern property determines the files to exclude.
If a stream is used with the Open method and the Zip destination is the same stream, the original source stream will be overwritten beginning at position 0.
If an error occurs for an individual item during this operation, the Archive.Exception Event will be raised.
' Be sure to import the namespace by putting "Imports Dart.PowerTCP.Zip" ' at the top of your class. ' Add a file using the ArchiveItem constructor Dim item = New ArchiveItem("c:\Test\\file1.txt") ' Add a comment to this item item.Comment = "This is file1.txt" ' Use encryption for just this item item.Encryption = Encryption.Standard item.Password = "testme" Archive1.Add(item) ' Add a file using the filename. This could also be used for adding wildcard collections Archive1.Add("c:\Test\file2.log") ' Add a wildcard collection of files ' In this case, all "txt" files in the directory "c:\Test" are added, except "file1.txt" ' Subfolders are not included, but the paths are preserved. Archive1.IncludeSubs = True Archive1.ExcludePattern = "file1.txt" Archive1.PreservePath = True Archive1.Add("c:\Test\*.txt") ' zip the data Archive1.Zip("c:\test.zip")
// Be sure to import the namespace by putting "using Dart.PowerTCP.Zip;" // at the top of your class. // Add a file using the ArchiveItem constructor ArchiveItem item = new ArchiveItem("c:\\Test\\file1.txt"); // Add a comment to this item item.Comment = "This is file1.txt"; // Use encryption for just this item item.Encryption = Encryption.Standard; item.Password = "testme"; archive1.Add(item); // Add a file using the filename. This could also be used for adding wildcard collections archive1.Add("c:\\Test\\file2.log"); // Add a wildcard collection of files // In this case, all "txt" files in the directory "c:\Test" are added, except "file1.txt" // Subfolders are not included, but the paths are preserved. archive1.IncludeSubs = true; archive1.ExcludePattern= "file1.txt"; archive1.PreservePath = true; archive1.Add("c:\\Test\\*.txt"); // Zip the data archive1.Zip("c:\\test.zip");