SolidFramework.Plumbing.GZip Class Reference

Represents GZip functionality More...

Static Public Member Functions
static GZipResult	Compress (string lpSourceFolder, string lpDestFolder, string zipFileName)
	Compress More...
static GZipResult	Compress (string lpSourceFolder, string searchPattern, SearchOption searchOption, string lpDestFolder, string zipFileName, bool deleteTempFile)
	Compress More...
static GZipResult	Compress (FileInfo[] files, string lpBaseFolder, string lpDestFolder, string zipFileName)
	Compress More...
static GZipResult	Compress (FileInfo[] files, string lpBaseFolder, string lpDestFolder, string zipFileName, bool deleteTempFile)
	Compress More...
static GZipResult	Decompress (Stream srcStream, string lpDestFolder, string zipFileName, ProgressTicker ticker)
	Decompresses the specified SRC stream. More...
static GZipResult	Decompress (string lpSourceFolder, string lpDestFolder, string zipFileName, Boolean deleteTempFile)
	Decompresses from the specified source folder. More...

Detailed Description

Represents GZip functionality

Member Function Documentation

Compress() [1/4]

static GZipResult SolidFramework.Plumbing.GZip.Compress ( FileInfo[]  files, string  lpBaseFolder, string  lpDestFolder, string  zipFileName  )

static

Compress

Parameters

files	Array of FileInfo objects to be included in the zip file
lpBaseFolder	Base folder to use when creating relative paths for the files stored in the zip file. For example, if lpBaseFolder is 'C:/zipTest/Files/', and there is a file 'C:/zipTest/Files/folder1/sample.txt' in the 'files' array, the relative path for sample.txt will be 'folder1/sample.txt'
lpDestFolder	Folder to write the zip file into
zipFileName	Name of the zip file to write

Compress() [2/4]

static GZipResult SolidFramework.Plumbing.GZip.Compress ( FileInfo[]  files, string  lpBaseFolder, string  lpDestFolder, string  zipFileName, bool  deleteTempFile  )

static

Compress

Parameters

files	Array of FileInfo objects to be included in the zip file
lpBaseFolder	Base folder to use when creating relative paths for the files stored in the zip file. For example, if lpBaseFolder is 'C:/zipTest/Files/', and there is a file 'C:/zipTest/Files/folder1/sample.txt' in the 'files' array, the relative path for sample.txt will be 'folder1/sample.txt'
lpDestFolder	Folder to write the zip file into
zipFileName	Name of the zip file to write
deleteTempFile	Boolean, true deleted the intermediate temp file, false leaves the temp file in lpDestFolder (for debugging)

Compress() [3/4]

static GZipResult SolidFramework.Plumbing.GZip.Compress ( string  lpSourceFolder, string  lpDestFolder, string  zipFileName  )

static

Compress

Parameters

lpSourceFolder	The location of the files to include in the zip file, all files including files in subfolders will be included.
lpDestFolder	Folder to write the zip file into
zipFileName	Name of the zip file to write

Compress() [4/4]

static GZipResult SolidFramework.Plumbing.GZip.Compress ( string  lpSourceFolder, string  searchPattern, SearchOption  searchOption, string  lpDestFolder, string  zipFileName, bool  deleteTempFile  )

static

Compress

Parameters

lpSourceFolder	The location of the files to include in the zip file
searchPattern	Search pattern (ie "*.*" or "*.txt" or "*.gif") to idendify what files in lpSourceFolder to include in the zip file
searchOption	Only files in lpSourceFolder or include files in subfolders also
lpDestFolder	Folder to write the zip file into
zipFileName	Name of the zip file to write
deleteTempFile	Boolean, true deleted the intermediate temp file, false leaves the temp file in lpDestFolder (for debugging)

Decompress() [1/2]

static GZipResult SolidFramework.Plumbing.GZip.Decompress ( Stream  srcStream, string  lpDestFolder, string  zipFileName, ProgressTicker  ticker  )

static

Decompresses the specified SRC stream.

Parameters

srcStream	The SRC stream.
lpDestFolder	The destination folder.
zipFileName	Name of the zip file.
ticker	The ticker.

Returns

Results

Decompress() [2/2]

static GZipResult SolidFramework.Plumbing.GZip.Decompress ( string  lpSourceFolder, string  lpDestFolder, string  zipFileName, Boolean  deleteTempFile  )

static

Decompresses from the specified source folder.

Parameters

lpSourceFolder	The source folder.
lpDestFolder	The destination folder.
zipFileName	Name of the zip file.
deleteTempFile	if set to true [delete temp file].

Returns

Results