Chilkat C# Gzip Class Reference
Gzip
GZip compression component.
Object Creation
(C#)
Chilkat.Gzip obj = new Chilkat.Gzip();
(VB.NET)
Dim obj As New Chilkat.Gzip()
Properties
public string Comment {get; set; }
Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called.
public bool EnableEvents {get; set; }
This property must be set to true to enable events. By default, it is false.
public byte[] ExtraData {get; set; }
Optional extra-data that can be included within a .gz when a Compress* method is called.
public string Filename {get; set; }
The filename that is embedded within the .gz during any Compress* method call. When extracting from a .gz using applications such as WinZip, this will be the filename that is created.
public string LastErrorHtml {get; }
Error information in HTML format for the last method called.
public string LastErrorText {get; }
Error information in plain-text format for the last method called.
public string LastErrorXml {get; }
Error information in XML format for the last method called.
public DateTime LastMod {get; set; }
The last-modification date/time to be embedded within the .gz when a Compress* method is called. By default, the current system date/time is used.
public bool UseCurrentDate {get; set; }
If set to true, the file produced by an Uncompress* method will use the current date/time for the last-modification date instead of the date/time found within the Gzip format.
public bool VerboseLogging {get; set; }
To be documented soon...
public string Version {get; }
Version of the component, such as "1.0.0"
Methods
public bool CompressFile(string inFilename, string outGzipFilename);
Compresses a file to create a GZip compressed file (.gz). Returns true for success, false for failure.
public bool CompressFile2(string inFilename, string embeddedFilename, string outGzipFilename);
Compresses a file to create a GZip compressed file (.gz). inFilename is the actual filename on disk. embeddedFilename is the filename to be embedded in the .gz such that when it is un-gzipped, this is the name of the file that will be created. Returns true for success, false for failure.
public byte[] CompressFileToMem(string inFilename);
Gzip compresses a file to an in-memory image of a .gz file. Returns a NULL object reference on failure. Returns an empty byte array on failure
public bool CompressMemToFile(byte[] inData, string outFilename);
Gzip compresses and creates a .gz file from in-memory data. Returns true for success, false for failure.
public byte[] CompressMemory(byte[] inData);
Compresses in-memory data to an in-memory image of a .gz file. Returns an empty byte array on failure
public byte[] CompressString(string inString, string outCharset);
Gzip compresses a string and writes the output to a byte array. The string is first converted to the charset specified by outCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc. Returns an empty byte array on failure Full List of Charset Names
public bool CompressStringToFile(string inStr, string outCharset, string outFilename);
Gzip compresses a string and writes the output to a .gz compressed file. The string is first converted to the charset specified by ARG2. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc. Returns true for success, false for failure. Full List of Charset Names
public byte[] Decode(string encodedStr, string encoding);
Decodes an encoded string and returns the original data. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url". Returns an empty byte array on failure
public string DeflateStringENC(string inString, string charsetName, string outputEncoding);
Provides the ability to use the zip/gzip's deflate algorithm directly to compress a string. Internal to this method, inString is first converted to the charset specified by charsetName. The data is then compressed using the deflate compression algorithm. The binary output is then encoded according to outputEncoding. Possible values for outputEncoding are "hex", "base64", "url", and "quoted-printable".
Note: The output of this method is compressed data with no Gzip file format. Use the Compress* methods to produce Gzip file format output. Returns a null on failure Full List of Charset Names
public string Encode(byte[] byteData, string encoding);
Encodes binary data to a printable string. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url". Returns a null on failure
public bool ExamineFile(string inGzFilename);
Determines if the inGzFilename is a Gzip formatted file. Returns true if it is a Gzip formatted file, otherwise returns false.
public bool ExamineMemory(byte[] inGzData);
Determines if the in-memory bytes (inGzData) contain a Gzip formatted file. Returns true if it is Gzip format, otherwise returns false.
public string InflateStringENC(string inString, string convertFromCharset, string inputEncoding);
This the reverse of DeflateStringENC.
The input string is first decoded according to inputEncoding. (Possible values for inputEncoding are "hex", "base64", "url", and "quoted-printable".) The compressed data is then inflated, and the result is then converted from convertFromCharset (if necessary) to return a string. Returns a null on failure
public bool IsUnlocked();
Returns true if the component has been unlocked.
public byte[] ReadFile(string filename);
Reads a binary file into memory and returns the byte array. Note: This method does not parse a Gzip, it is only a convenience method for reading a binary file into memory. Returns an empty byte array on failure
public bool SaveLastError(string filename);
Saves the last error information to an XML formatted file.
public bool UnTarGz(string tgzFilename, string destDir, bool bNoAbsolute);
Unpacks a .tar.gz file. The ungzip and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring. bNoAbsolute may be true or false. A value of true protects from untarring to absolute paths. (For example, imagine the trouble if the tar contains files with absolute paths beginning with /Windows/system32) Returns true for success, false for failure.
public bool UncompressFile(string inFilename, string outFilename);
Un-Gzips a .gz file. The output filename is specified by the 2nd argument and not by the filename embedded within the .gz. Returns true for success, false for failure.
public byte[] UncompressFileToMem(string inFilename);
Un-Gzips a .gz file directly to memory. Returns a NULL object reference on failure. Returns an empty byte array on failure
public string UncompressFileToString(string gzFilename, string charset);
Uncompresses a .gz file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc. Returns a null on failure List of Valid Charsets
public bool UncompressMemToFile(byte[] inData, string outFilename);
Un-Gzips from an in-memory image of a .gz file to a file. Returns true for success, false for failure.
public byte[] UncompressMemory(byte[] inData);
Un-Gzips from an in-memory image of a .gz file directly into memory. Returns a NULL object reference on failure. Returns an empty byte array on failure
public string UncompressString(byte[] inData, string inCharset);
The reverse of CompressString.
The bytes in inData are uncompressed, then converted from inCharset (if necessary) to return a string. Returns a null on failure Full List of Charset Names
public bool UnlockComponent(string unlockCode);
Unlocks the component allowing for the full functionality to be used. Returns true for success, false for failure.
public bool WriteFile(string filename, byte[] binaryData);
A convenience method for writing a binary byte array to a file. Returns true for success, false for failure.
public string XfdlToXml(string xfldData);
Converts base64-gzip .xfdl data to a decompressed XML string. The xfldData contains the base64 data. This method returns the decoded/decompressed XML string. Returns a null on failure
|