ExtensionsZipAsFileAsync Method (Stream, FileInfo, Boolean)

Comptesses a stream to a file using gzip

Namespace: Cauldron
Assembly: Cauldron (in Cauldron.dll) Version: 3.2.0.2

Syntax

public static Task<FileInfo> ZipAsFileAsync(
	this Stream stream,
	FileInfo file,
	bool overwrite = false
)

<ExtensionAttribute>
Public Shared Function ZipAsFileAsync ( 
	stream As Stream,
	file As FileInfo,
	Optional overwrite As Boolean = false
) As Task(Of FileInfo)

public:
[ExtensionAttribute]
static Task<FileInfo^>^ ZipAsFileAsync(
	Stream^ stream, 
	FileInfo^ file, 
	bool overwrite = false
)

Parameters

stream: Type: System.IOStream
The stream to compress
file: Type: System.IOFileInfo
The target file.
overwrite (Optional): Type: SystemBoolean
Overwrite the file if exists.

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 Stream. 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).

Reference

Extensions Class

ZipAsFileAsync Overload

Cauldron Namespace

ExtensionsAddLanguageSpecificTextSet("LSTF6E846B_0?cpp=::|nu=.");ZipAsFileAsync Method (Stream, FileInfo, Boolean)

Parameters

Return Value

Usage Note

Reference

ExtensionsZipAsFileAsync Method (Stream, FileInfo, Boolean)