Click or drag to resize

ExtensionsZipAsFileAsync Method (FileInfo, FileInfo, Boolean)

Compresses a file using gzip.

Namespace:  Cauldron
Assembly:  Cauldron (in Cauldron.dll) Version: 3.2.0.1 (3.2.0.1)
Syntax
C#
Copy
public static Task<FileInfo> ZipAsFileAsync(
	this FileInfo file,
	FileInfo targetFile,
	bool overwrite = false
)

Parameters

file
Type: System.IOFileInfo
The file to compress
targetFile
Type: System.IOFileInfo
The target file.
overwrite (Optional)
Type: SystemBoolean
If true, overwrites the file if exists; otherwise false

Return Value

Type: TaskFileInfo
The new compressed file represented by FileInfo

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type FileInfo. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also