Permalink
Fetching contributors…
Cannot retrieve contributors at this time
9056 lines (8996 sloc) 436 KB
<?xml version="1.0"?>
<doc>
<assembly>
<name>ICSharpCode.SharpZipLib</name>
</assembly>
<members>
<member name="T:ICSharpCode.SharpZipLib.Zip.FastZipEvents">
<summary>
FastZipEvents supports all events applicable to <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip">FastZip</see> operations.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessDirectory">
<summary>
Delegate to invoke when processing directories.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessFile">
<summary>
Delegate to invoke when processing files.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress">
<summary>
Delegate to invoke during processing of files.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.CompletedFile">
<summary>
Delegate to invoke when processing for a file has been completed.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.DirectoryFailure">
<summary>
Delegate to invoke when processing directory failures.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.FileFailure">
<summary>
Delegate to invoke when processing file failures.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnDirectoryFailure(System.String,System.Exception)">
<summary>
Raise the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.DirectoryFailure">directory failure</see> event.
</summary>
<param name="directory">The directory causing the failure.</param>
<param name="e">The exception for this event.</param>
<returns>A boolean indicating if execution should continue or not.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnFileFailure(System.String,System.Exception)">
<summary>
Raises the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.FileFailure">file failure delegate</see>.
</summary>
<param name="file">The file causing the failure.</param>
<param name="e">The exception for this failure.</param>
<returns>A boolean indicating if execution should continue or not.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnProcessFile(System.String)">
<summary>
Fires the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessFile">Process File delegate</see>.
</summary>
<param name="file">The file being processed.</param>
<returns>A boolean indicating if execution should continue or not.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnCompletedFile(System.String)">
<summary>
Fires the CompletedFile delegate
</summary>
<param name="file">The file whose processing has been completed.</param>
<returns>A boolean indicating if execution should continue or not.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnProcessDirectory(System.String,System.Boolean)">
<summary>
Fires the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessDirectory">process directory</see> delegate.
</summary>
<param name="directory">The directory being processed.</param>
<param name="hasMatchingFiles">Flag indicating if the directory has matching files as determined by the current filter.</param>
<returns>A <see cref="T:System.Boolean"/> of true if the operation should continue; false otherwise.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProgressInterval">
<summary>
The minimum timespan between <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress"/> events.
</summary>
<value>The minimum period of time between <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress"/> events.</value>
<seealso cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress"/>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.FastZip">
<summary>
FastZip provides facilities for creating and extracting zip files.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.#ctor">
<summary>
Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip"/>.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.#ctor(ICSharpCode.SharpZipLib.Zip.FastZipEvents)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip"/>
</summary>
<param name="events">The <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZipEvents">events</see> to use during operations.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.String,System.String,System.Boolean,System.String,System.String)">
<summary>
Create a zip file.
</summary>
<param name="zipFileName">The name of the zip file to create.</param>
<param name="sourceDirectory">The directory to source files from.</param>
<param name="recurse">True to recurse directories, false for no recursion.</param>
<param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">file filter</see> to apply.</param>
<param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">directory filter</see> to apply.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.String,System.String,System.Boolean,System.String)">
<summary>
Create a zip file/archive.
</summary>
<param name="zipFileName">The name of the zip file to create.</param>
<param name="sourceDirectory">The directory to obtain files and directories from.</param>
<param name="recurse">True to recurse directories, false for no recursion.</param>
<param name="fileFilter">The file filter to apply.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.IO.Stream,System.String,System.Boolean,System.String,System.String)">
<summary>
Create a zip archive sending output to the <paramref name="outputStream"/> passed.
</summary>
<param name="outputStream">The stream to write archive data to.</param>
<param name="sourceDirectory">The directory to source files from.</param>
<param name="recurse">True to recurse directories, false for no recursion.</param>
<param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">file filter</see> to apply.</param>
<param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">directory filter</see> to apply.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.ExtractZip(System.String,System.String,System.String)">
<summary>
Extract the contents of a zip file.
</summary>
<param name="zipFileName">The zip file to extract from.</param>
<param name="targetDirectory">The directory to save extracted information in.</param>
<param name="fileFilter">A filter to apply to files.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.ExtractZip(System.String,System.String,ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite,ICSharpCode.SharpZipLib.Zip.FastZip.ConfirmOverwriteDelegate,System.String,System.String,System.Boolean)">
<summary>
Extract the contents of a zip file.
</summary>
<param name="zipFileName">The zip file to extract from.</param>
<param name="targetDirectory">The directory to save extracted information in.</param>
<param name="overwrite">The style of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite">overwriting</see> to apply.</param>
<param name="confirmDelegate">A delegate to invoke when confirming overwriting.</param>
<param name="fileFilter">A filter to apply to files.</param>
<param name="directoryFilter">A filter to apply to directories.</param>
<param name="restoreDateTime">Flag indicating wether to restore the date and time for extracted files.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.CreateEmptyDirectories">
<summary>
Get/set a value indicating wether empty directories should be created.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.Password">
<summary>
Get / set the password value.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.NameTransform">
<summary>
Get or set the <see cref="T:ICSharpCode.SharpZipLib.Core.INameTransform"></see> active when creating Zip files.
</summary>
<seealso cref="P:ICSharpCode.SharpZipLib.Zip.FastZip.EntryFactory"></seealso>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.EntryFactory">
<summary>
Get or set the <see cref="T:ICSharpCode.SharpZipLib.Zip.IEntryFactory"></see> active when creating Zip files.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.RestoreDateTimeOnExtract">
<summary>
Get/set a value indicating wether file dates and times should
be restored when extracting files from an archive.
</summary>
<remarks>The default value is false.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.RestoreAttributesOnExtract">
<summary>
Get/set a value indicating wether file attributes should
be restored during extract operations
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite">
<summary>
Defines the desired handling when overwriting files during extraction.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite.Prompt">
<summary>
Prompt the user to confirm overwriting
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite.Never">
<summary>
Never overwrite files.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite.Always">
<summary>
Always overwrite files.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.FastZip.ConfirmOverwriteDelegate">
<summary>
Delegate called when confirming overwriting of files.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.NameFilter">
<summary>
NameFilter is a string matching class which allows for both positive and negative
matching.
A filter is a sequence of independant <see cref="T:System.Text.RegularExpressions.Regex">regular expressions</see> separated by semi-colons ';'
Each expression can be prefixed by a plus '+' sign or a minus '-' sign to denote the expression
is intended to include or exclude names. If neither a plus or minus sign is found include is the default
A given name is tested for inclusion before checking exclusions. Only names matching an include spec
and not matching an exclude spec are deemed to match the filter.
An empty filter matches any name.
</summary>
<example>The following expression includes all name ending in '.dat' with the exception of 'dummy.dat'
"+\.dat$;-^dummy\.dat$"
</example>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.IScanFilter">
<summary>
Scanning filters support filtering of names.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.IScanFilter.IsMatch(System.String)">
<summary>
Test a name to see if it 'matches' the filter.
</summary>
<param name="name">The name to test.</param>
<returns>Returns true if the name matches the filter, false if it does not match.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.#ctor(System.String)">
<summary>
Construct an instance based on the filter expression passed
</summary>
<param name="filter">The filter expression.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsValidExpression(System.String)">
<summary>
Test a string to see if it is a valid regular expression.
</summary>
<param name="expression">The expression to test.</param>
<returns>True if expression is a valid <see cref="T:System.Text.RegularExpressions.Regex"/> false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsValidFilterExpression(System.String)">
<summary>
Test an expression to see if it is valid as a filter.
</summary>
<param name="toTest">The filter expression to test.</param>
<returns>True if the expression is valid, false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.ToString">
<summary>
Convert this filter to its string equivalent.
</summary>
<returns>The string equivalent for this filter.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsIncluded(System.String)">
<summary>
Test a value to see if it is included by the filter.
</summary>
<param name="name">The value to test.</param>
<returns>True if the value is included, false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsExcluded(System.String)">
<summary>
Test a value to see if it is excluded by the filter.
</summary>
<param name="name">The value to test.</param>
<returns>True if the value is excluded, false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsMatch(System.String)">
<summary>
Test a value to see if it matches the filter.
</summary>
<param name="name">The value to test.</param>
<returns>True if the value matches, false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.Compile">
<summary>
Compile this filter.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree">
<summary>
Huffman tree used for inflation
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.defLitLenTree">
<summary>
Literal length tree
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.defDistTree">
<summary>
Distance tree
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.#ctor(System.Byte[])">
<summary>
Constructs a Huffman tree from the array of code lengths.
</summary>
<param name = "codeLengths">
the array of code lengths
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.GetSymbol(ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator)">
<summary>
Reads the next symbol from input. The symbol is encoded using the
huffman tree.
</summary>
<param name="input">
input the input source.
</param>
<returns>
the next symbol, or -1 if not enough input is available.
</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer">
<summary>
This class is general purpose class for writing data to a buffer.
It allows you to write bits as well as bytes
Based on DeflaterPending.java
author of the original java version : Jochen Hoenicke
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.buffer_">
<summary>
Internal work buffer
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.#ctor">
<summary>
construct instance using default buffer size of 4096
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.#ctor(System.Int32)">
<summary>
construct instance using specified buffer size
</summary>
<param name="bufferSize">
size to use for internal buffer
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.Reset">
<summary>
Clear internal state/buffers
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteByte(System.Int32)">
<summary>
Write a byte to buffer
</summary>
<param name="value">
The value to write
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteShort(System.Int32)">
<summary>
Write a short value to buffer LSB first
</summary>
<param name="value">
The value to write.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteInt(System.Int32)">
<summary>
write an integer LSB first
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Write a block of data to buffer
</summary>
<param name="block">data to write</param>
<param name="offset">offset of first byte to write</param>
<param name="length">number of bytes to write</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.AlignToByte">
<summary>
Align internal buffer on a byte boundary
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteBits(System.Int32,System.Int32)">
<summary>
Write bits to internal buffer
</summary>
<param name="b">source of bits</param>
<param name="count">number of bits to write</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteShortMSB(System.Int32)">
<summary>
Write a short value to internal buffer most significant byte first
</summary>
<param name="s">value to write</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.Flush(System.Byte[],System.Int32,System.Int32)">
<summary>
Flushes the pending buffer into the given output array. If the
output array is to small, only a partial flush is done.
</summary>
<param name="output">The output array.</param>
<param name="offset">The offset into output array.</param>
<param name="length">The maximum number of bytes to store.</param>
<returns>The number of bytes flushed.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.ToByteArray">
<summary>
Convert internal buffer to byte array.
Buffer is empty on completion
</summary>
<returns>
The internal buffer contents converted to a byte array.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.BitCount">
<summary>
The number of bits written to the buffer
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.IsFlushed">
<summary>
Indicates if buffer has been flushed
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Tar.ProgressMessageHandler">
<summary>
Used to advise clients of 'events' while processing archives
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Tar.TarArchive">
<summary>
The TarArchive class implements the concept of a
'Tape Archive'. A tar archive is a series of entries, each of
which represents a file system object. Each entry in
the archive consists of a header block followed by 0 or more data blocks.
Directory entries consist only of the header block, and are followed by entries
for the directory's contents. File entries consist of a
header followed by the number of blocks needed to
contain the file's contents. All entries are written on
block boundaries. Blocks are 512 bytes long.
TarArchives are instantiated in either read or write mode,
based upon whether they are instantiated with an InputStream
or an OutputStream. Once instantiated TarArchives read/write
mode can not be changed.
There is currently no support for random access to tar archives.
However, it seems that subclassing TarArchive, and using the
TarBuffer.CurrentRecord and TarBuffer.CurrentBlock
properties, this would be rather trivial.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.OnProgressMessageEvent(ICSharpCode.SharpZipLib.Tar.TarEntry,System.String)">
<summary>
Raises the ProgressMessage event
</summary>
<param name="entry">The <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry">TarEntry</see> for this event</param>
<param name="message">message for this event. Null is no message</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.#ctor">
<summary>
Constructor for a default <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/>.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.#ctor(ICSharpCode.SharpZipLib.Tar.TarInputStream)">
<summary>
Initalise a TarArchive for input.
</summary>
<param name="stream">The <see cref="T:ICSharpCode.SharpZipLib.Tar.TarInputStream"/> to use for input.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.#ctor(ICSharpCode.SharpZipLib.Tar.TarOutputStream)">
<summary>
Initialise a TarArchive for output.
</summary>
<param name="stream">The <see cref="T:ICSharpCode.SharpZipLib.Tar.TarOutputStream"/> to use for output.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateInputTarArchive(System.IO.Stream)">
<summary>
The InputStream based constructors create a TarArchive for the
purposes of extracting or listing a tar archive. Thus, use
these constructors when you wish to extract files from or list
the contents of an existing tar archive.
</summary>
<param name="inputStream">The stream to retrieve archive data from.</param>
<returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for reading from.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateInputTarArchive(System.IO.Stream,System.Int32)">
<summary>
Create TarArchive for reading setting block factor
</summary>
<param name="inputStream">Stream for tar archive contents</param>
<param name="blockFactor">The blocking factor to apply</param>
<returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for reading.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateOutputTarArchive(System.IO.Stream)">
<summary>
Create a TarArchive for writing to, using the default blocking factor
</summary>
<param name="outputStream">The <see cref="T:System.IO.Stream"/> to write to</param>
<returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for writing.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateOutputTarArchive(System.IO.Stream,System.Int32)">
<summary>
Create a TarArchive for writing to
</summary>
<param name="outputStream">The stream to write to</param>
<param name="blockFactor">The blocking factor to use for buffering.</param>
<returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for writing.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetKeepOldFiles(System.Boolean)">
<summary>
Set the flag that determines whether existing files are
kept, or overwritten during extraction.
</summary>
<param name="keepOldFiles">
If true, do not overwrite existing files.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetAsciiTranslation(System.Boolean)">
<summary>
Set the ascii file translation flag.
</summary>
<param name= "asciiTranslate">
If true, translate ascii text files.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetUserInfo(System.Int32,System.String,System.Int32,System.String)">
<summary>
Set user and group information that will be used to fill in the
tar archive's entry headers. This information based on that available
for the linux operating system, which is not always available on other
operating systems. TarArchive allows the programmer to specify values
to be used in their place.
<see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides"/> is set to true by this call.
</summary>
<param name="userId">
The user id to use in the headers.
</param>
<param name="userName">
The user name to use in the headers.
</param>
<param name="groupId">
The group id to use in the headers.
</param>
<param name="groupName">
The group name to use in the headers.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CloseArchive">
<summary>
Close the archive.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.ListContents">
<summary>
Perform the "list" command for the archive contents.
NOTE That this method uses the <see cref="E:ICSharpCode.SharpZipLib.Tar.TarArchive.ProgressMessageEvent"> progress event</see> to actually list
the contents. If the progress display event is not set, nothing will be listed!
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.ExtractContents(System.String)">
<summary>
Perform the "extract" command and extract the contents of the archive.
</summary>
<param name="destinationDirectory">
The destination directory into which to extract.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.ExtractEntry(System.String,ICSharpCode.SharpZipLib.Tar.TarEntry)">
<summary>
Extract an entry from the archive. This method assumes that the
tarIn stream has been properly set with a call to GetNextEntry().
</summary>
<param name="destDir">
The destination directory into which to extract.
</param>
<param name="entry">
The TarEntry returned by tarIn.GetNextEntry().
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.WriteEntry(ICSharpCode.SharpZipLib.Tar.TarEntry,System.Boolean)">
<summary>
Write an entry to the archive. This method will call the putNextEntry
and then write the contents of the entry, and finally call closeEntry()
for entries that are files. For directories, it will call putNextEntry(),
and then, if the recurse flag is true, process each entry that is a
child of the directory.
</summary>
<param name="sourceEntry">
The TarEntry representing the entry to write to the archive.
</param>
<param name="recurse">
If true, process the children of directory entries.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.InternalWriteEntry(ICSharpCode.SharpZipLib.Tar.TarEntry,System.Boolean)">
<summary>
Write an entry to the archive. This method will call the putNextEntry
and then write the contents of the entry, and finally call closeEntry()
for entries that are files. For directories, it will call putNextEntry(),
and then, if the recurse flag is true, process each entry that is a
child of the directory.
</summary>
<param name="sourceEntry">
The TarEntry representing the entry to write to the archive.
</param>
<param name="recurse">
If true, process the children of directory entries.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.Dispose(System.Boolean)">
<summary>
Releases the unmanaged resources used by the FileStream and optionally releases the managed resources.
</summary>
<param name="disposing">true to release both managed and unmanaged resources;
false to release only unmanaged resources.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.Close">
<summary>
Closes the archive and releases any associated resources.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.Finalize">
<summary>
Ensures that resources are freed and other cleanup operations are performed
when the garbage collector reclaims the <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/>.
</summary>
</member>
<member name="E:ICSharpCode.SharpZipLib.Tar.TarArchive.ProgressMessageEvent">
<summary>
Client hook allowing detailed information to be reported during processing
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.AsciiTranslate">
<summary>
Get/set the ascii file translation flag. If ascii file translation
is true, then the file is checked to see if it a binary file or not.
If the flag is true and the test indicates it is ascii text
file, it will be translated. The translation converts the local
operating system's concept of line ends into the UNIX line end,
'\n', which is the defacto standard for a TAR archive. This makes
text files compatible with UNIX.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.PathPrefix">
<summary>
PathPrefix is added to entry names as they are written if the value is not null.
A slash character is appended after PathPrefix
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.RootPath">
<summary>
RootPath is removed from entry names if it is found at the
beginning of the name.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">
<summary>
Get or set a value indicating if overrides defined by <see cref="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetUserInfo(System.Int32,System.String,System.Int32,System.String)">SetUserInfo</see> should be applied.
</summary>
<remarks>If overrides are not applied then the values as set in each header will be used.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.UserId">
<summary>
Get the archive user id.
See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
on how to allow setting values on a per entry basis.
</summary>
<returns>
The current user id.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.UserName">
<summary>
Get the archive user name.
See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
on how to allow setting values on a per entry basis.
</summary>
<returns>
The current user name.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.GroupId">
<summary>
Get the archive group id.
See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
on how to allow setting values on a per entry basis.
</summary>
<returns>
The current group id.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.GroupName">
<summary>
Get the archive group name.
See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
on how to allow setting values on a per entry basis.
</summary>
<returns>
The current group name.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.RecordSize">
<summary>
Get the archive's record size. Tar archives are composed of
a series of RECORDS each containing a number of BLOCKS.
This allowed tar archives to match the IO characteristics of
the physical device being used. Archives are expected
to be properly "blocked".
</summary>
<returns>
The record size this archive is using.
</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream">
<summary>
An output stream that compresses into the BZip2 format
including file header chars into another stream.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.#ctor(System.IO.Stream)">
<summary>
Construct a default output stream with maximum block size
</summary>
<param name="stream">The stream to write BZip data onto.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Initialise a new instance of the <see cref="T:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream"></see>
for the specified stream, using the given blocksize.
</summary>
<param name="stream">The stream to write compressed data to.</param>
<param name="blockSize">The block size to use.</param>
<remarks>
Valid block sizes are in the range 1..9, with 1 giving
the lowest compression and 9 the highest.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Finalize">
<summary>
Ensures that resources are freed and other cleanup operations
are performed when the garbage collector reclaims the BZip2OutputStream.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the current position of this stream to the given value.
</summary>
<param name="offset">The point relative to the offset from which to being seeking.</param>
<param name="origin">The reference point from which to begin seeking.</param>
<returns>The new position in the stream.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.SetLength(System.Int64)">
<summary>
Sets the length of this stream to the given value.
</summary>
<param name="value">The new stream length.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.ReadByte">
<summary>
Read a byte from the stream advancing the position.
</summary>
<returns>The byte read cast to an int; -1 if end of stream.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read a block of bytes
</summary>
<param name="buffer">The buffer to read into.</param>
<param name="offset">The offset in the buffer to start storing data at.</param>
<param name="count">The maximum number of bytes to read.</param>
<returns>The total number of bytes read. This might be less than the number of bytes
requested if that number of bytes are not currently available, or zero
if the end of the stream is reached.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write a block of bytes to the stream
</summary>
<param name="buffer">The buffer containing data to write.</param>
<param name="offset">The offset of the first byte to write.</param>
<param name="count">The number of bytes to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.WriteByte(System.Byte)">
<summary>
Write a byte to the stream.
</summary>
<param name="value">The byte to write to the stream.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Close">
<summary>
End the current block and end compression.
Close the stream and free any resources
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.WriteRun">
<summary>
Get the number of bytes written to output.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Dispose(System.Boolean)">
<summary>
Releases the unmanaged resources used by the <see cref="T:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream"/> and optionally releases the managed resources.
</summary>
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Flush">
<summary>
Flush output buffers
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.IsStreamOwner">
<summary>
Get/set flag indicating ownership of underlying stream.
When the flag is true <see cref="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Close"></see> will close the underlying stream also.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.CanRead">
<summary>
Gets a value indicating whether the current stream supports reading
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.CanWrite">
<summary>
Gets a value indicating whether the current stream supports writing
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Length">
<summary>
Gets the length in bytes of the stream
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Position">
<summary>
Gets or sets the current position of this stream.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.BytesWritten">
<summary>
Get the number of bytes written to the output.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipException">
<summary>
Represents exception conditions specific to Zip archive handling
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
<summary>
SharpZipBaseException is the base exception class for the SharpZipLibrary.
All library exceptions are derived from this.
</summary>
<remarks>NOTE: Not all exceptions thrown will be derived from this class.
A variety of other exceptions are possible for example <see cref="T:System.ArgumentNullException"></see></remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Deserialization constructor
</summary>
<param name="info"><see cref="T:System.Runtime.Serialization.SerializationInfo"/> for this constructor</param>
<param name="context"><see cref="T:System.Runtime.Serialization.StreamingContext"/> for this constructor</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor">
<summary>
Initializes a new instance of the SharpZipBaseException class.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.String)">
<summary>
Initializes a new instance of the SharpZipBaseException class with a specified error message.
</summary>
<param name="message">A message describing the exception.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the SharpZipBaseException class with a specified
error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">A message describing the exception.</param>
<param name="innerException">The inner exception</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Deserialization constructor
</summary>
<param name="info"><see cref="T:System.Runtime.Serialization.SerializationInfo"/> for this constructor</param>
<param name="context"><see cref="T:System.Runtime.Serialization.StreamingContext"/> for this constructor</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor">
<summary>
Initializes a new instance of the ZipException class.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.String)">
<summary>
Initializes a new instance of the ZipException class with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.String,System.Exception)">
<summary>
Initialise a new instance of ZipException.
</summary>
<param name="message">A message describing the error.</param>
<param name="exception">The exception that is the cause of the current exception.</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2">
<summary>
A helper class to simplify compressing and decompressing streams.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2.Decompress(System.IO.Stream,System.IO.Stream)">
<summary>
Decompress <paramref name="inStream">input</paramref> writing
decompressed data to the <paramref name="outStream">output stream</paramref>
</summary>
<param name="inStream">The stream containing data to decompress.</param>
<param name="outStream">The stream to write decompressed data to.</param>
<remarks>Both streams are closed on completion</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2.Compress(System.IO.Stream,System.IO.Stream,System.Int32)">
<summary>
Compress <paramref name="inStream">input stream</paramref> sending
result to <paramref name="outStream">output stream</paramref>
</summary>
<param name="inStream">The stream to compress.</param>
<param name="outStream">The stream to write compressed data to.</param>
<param name="blockSize">The block size to use.</param>
<remarks>Both streams are closed on completion</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2.#ctor">
<summary>
Initialise a default instance of this class.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.UseZip64">
<summary>
Determines how entries are tested to see if they should use Zip64 extensions or not.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.Off">
<summary>
Zip64 will not be forced on entries during processing.
</summary>
<remarks>An entry can have this overridden if required <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ForceZip64"></see></remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.On">
<summary>
Zip64 should always be used.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.Dynamic">
<summary>
#ZipLib will determine use based on entry values when added to archive.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.CompressionMethod">
<summary>
The kind of compression used for an entry in an archive
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Stored">
<summary>
A direct copy of the file contents is held in the archive
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Deflated">
<summary>
Common Zip compression method using a sliding dictionary
of up to 32KB and secondary compression from Huffman/Shannon-Fano trees
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Deflate64">
<summary>
An extension to deflate with a 64KB window. Not supported by #Zip currently
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.BZip2">
<summary>
Not supported by #Zip currently
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.WinZipAES">
<summary>
WinZip special for AES encryption, Not supported by #Zip
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm">
<summary>
Identifies the encryption algorithm used for an entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.None">
<summary>
No encryption has been used.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.PkzipClassic">
<summary>
Encrypted using PKZIP 2.0 or 'classic' encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Des">
<summary>
DES encryption has been used.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC2">
<summary>
RCS encryption has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.TripleDes168">
<summary>
Triple DES encryption with 168 bit keys has been used for this entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.TripleDes112">
<summary>
Triple DES with 112 bit keys has been used for this entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes128">
<summary>
AES 128 has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes192">
<summary>
AES 192 has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes256">
<summary>
AES 256 has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC2Corrected">
<summary>
RC2 corrected has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Blowfish">
<summary>
Blowfish has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Twofish">
<summary>
Twofish has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC4">
<summary>
RCS has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Unknown">
<summary>
An unknown algorithm has been used for encryption.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">
<summary>
Defines the contents of the general bit flags field for an archive entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Encrypted">
<summary>
Bit 0 if set indicates that the file is encrypted
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Method">
<summary>
Bits 1 and 2 - Two bits defining the compression method (only for Method 6 Imploding and 8,9 Deflating)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Descriptor">
<summary>
Bit 3 if set indicates a trailing data desciptor is appended to the entry data
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPKware4">
<summary>
Bit 4 is reserved for use with method 8 for enhanced deflation
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Patched">
<summary>
Bit 5 if set indicates the file contains Pkzip compressed patched data.
Requires version 2.7 or greater.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.StrongEncryption">
<summary>
Bit 6 if set strong encryption has been used for this entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused7">
<summary>
Bit 7 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused8">
<summary>
Bit 8 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused9">
<summary>
Bit 9 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused10">
<summary>
Bit 10 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.UnicodeText">
<summary>
Bit 11 if set indicates the filename and
comment fields for this file must be encoded using UTF-8.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.EnhancedCompress">
<summary>
Bit 12 is documented as being reserved by PKware for enhanced compression.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.HeaderMasked">
<summary>
Bit 13 if set indicates that values in the local header are masked to hide
their actual values, and the central directory is encrypted.
</summary>
<remarks>
Used when encrypting the central directory contents.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPkware14">
<summary>
Bit 14 is documented as being reserved for use by PKware
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPkware15">
<summary>
Bit 15 is documented as being reserved for use by PKware
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipConstants">
<summary>
This class contains constants used for Zip format files
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionMadeBy">
<summary>
The version made by field for entries in the central header when created by this library
</summary>
<remarks>
This is also the Zip version for the library when comparing against the version required to extract
for an entry. See <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CanDecompress"/>.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_MADE_BY">
<summary>
The version made by field for entries in the central header when created by this library
</summary>
<remarks>
This is also the Zip version for the library when comparing against the version required to extract
for an entry. See <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CanDecompressEntry">ZipInputStream.CanDecompressEntry</see>.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionStrongEncryption">
<summary>
The minimum version required to support strong encryption
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_STRONG_ENCRYPTION">
<summary>
The minimum version required to support strong encryption
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionZip64">
<summary>
The version required for Zip64 extensions
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LocalHeaderBaseSize">
<summary>
Size of local entry header (excluding variable length fields at end)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LOCHDR">
<summary>
Size of local entry header (excluding variable length fields at end)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64DataDescriptorSize">
<summary>
Size of Zip64 data descriptor
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.DataDescriptorSize">
<summary>
Size of data descriptor
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EXTHDR">
<summary>
Size of data descriptor
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderBaseSize">
<summary>
Size of central header entry (excluding variable fields)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENHDR">
<summary>
Size of central header entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EndOfCentralRecordBaseSize">
<summary>
Size of end of central record (excluding variable fields)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ENDHDR">
<summary>
Size of end of central record (excluding variable fields)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CryptoHeaderSize">
<summary>
Size of 'classic' cryptographic header stored before any entry data
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CRYPTO_HEADER_SIZE">
<summary>
Size of cryptographic header stored before entry data
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LocalHeaderSignature">
<summary>
Signature for local entry header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LOCSIG">
<summary>
Signature for local entry header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SpanningSignature">
<summary>
Signature for spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SPANNINGSIG">
<summary>
Signature for spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SpanningTempSignature">
<summary>
Signature for temporary spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SPANTEMPSIG">
<summary>
Signature for temporary spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.DataDescriptorSignature">
<summary>
Signature for data descriptor
</summary>
<remarks>
This is only used where the length, Crc, or compressed size isnt known when the
entry is created and the output stream doesnt support seeking.
The local entry cannot be 'patched' with the correct values in this case
so the values are recorded after the data prefixed by this header, as well as in the central directory.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EXTSIG">
<summary>
Signature for data descriptor
</summary>
<remarks>
This is only used where the length, Crc, or compressed size isnt known when the
entry is created and the output stream doesnt support seeking.
The local entry cannot be 'patched' with the correct values in this case
so the values are recorded after the data prefixed by this header, as well as in the central directory.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENSIG">
<summary>
Signature for central header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderSignature">
<summary>
Signature for central header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64CentralFileHeaderSignature">
<summary>
Signature for Zip64 central file header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENSIG64">
<summary>
Signature for Zip64 central file header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64CentralDirLocatorSignature">
<summary>
Signature for Zip64 central directory locator
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ArchiveExtraDataSignature">
<summary>
Signature for archive extra data signature (were headers are encrypted).
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderDigitalSignature">
<summary>
Central header digitial signature
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENDIGITALSIG">
<summary>
Central header digitial signature
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EndOfCentralDirectorySignature">
<summary>
End of central directory record signature
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ENDSIG">
<summary>
End of central directory record signature
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToString(System.Byte[],System.Int32)">
<summary>
Convert a portion of a byte array to a string.
</summary>
<param name="data">
Data to convert to string
</param>
<param name="count">
Number of bytes to convert starting from index 0
</param>
<returns>
data[0]..data[length - 1] converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToString(System.Byte[])">
<summary>
Convert a byte array to string
</summary>
<param name="data">
Byte array to convert
</param>
<returns>
<paramref name="data">data</paramref>converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToStringExt(System.Int32,System.Byte[],System.Int32)">
<summary>
Convert a byte array to string
</summary>
<param name="flags">The applicable general purpose bits flags</param>
<param name="data">
Byte array to convert
</param>
<param name="count">The number of bytes to convert.</param>
<returns>
<paramref name="data">data</paramref>converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToStringExt(System.Int32,System.Byte[])">
<summary>
Convert a byte array to string
</summary>
<param name="data">
Byte array to convert
</param>
<param name="flags">The applicable general purpose bits flags</param>
<returns>
<paramref name="data">data</paramref>converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToArray(System.String)">
<summary>
Convert a string to a byte array
</summary>
<param name="str">
String to convert to an array
</param>
<returns>Converted array</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToArray(System.Int32,System.String)">
<summary>
Convert a string to a byte array
</summary>
<param name="flags">The applicable general purpose bits flags</param>
<param name="str">
String to convert to an array
</param>
<returns>Converted array</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.#ctor">
<summary>
Initialise default instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipConstants">ZipConstants</see>
</summary>
<remarks>
Private to prevent instances being created.
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipConstants.DefaultCodePage">
<summary>
Default encoding used for string conversion. 0 gives the default system OEM code page.
Dont use unicode encodings if you want to be Zip compatible!
Using the default code page isnt the full solution neccessarily
there are many variable factors, codepage 850 is often a good choice for
European users, however be careful about compatability.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipOutputStream">
<summary>
This is a DeflaterOutputStream that writes the files into a zip
archive one after another. It has a special method to start a new
zip entry. The zip entries contains information about the file name
size, compressed size, CRC, etc.
It includes support for Stored and Deflated entries.
This class is not thread safe.
<br/>
<br/>Author of the original java version : Jochen Hoenicke
</summary>
<example> This sample shows how to create a zip file
<code>
using System;
using System.IO;
using ICSharpCode.SharpZipLib.Core;
using ICSharpCode.SharpZipLib.Zip;
class MainClass
{
public static void Main(string[] args)
{
string[] filenames = Directory.GetFiles(args[0]);
byte[] buffer = new byte[4096];
using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) {
s.SetLevel(9); // 0 - store only to 9 - means best compression
foreach (string file in filenames) {
ZipEntry entry = new ZipEntry(file);
s.PutNextEntry(entry);
using (FileStream fs = File.OpenRead(file)) {
StreamUtils.Copy(fs, s, buffer);
}
}
}
}
}
</code>
</example>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream">
<summary>
A special stream deflating or compressing the bytes that are
written to it. It uses a Deflater to perform actual deflating.<br/>
Authors of the original java version : Tom Tromey, Jochen Hoenicke
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream)">
<summary>
Creates a new DeflaterOutputStream with a default Deflater and default buffer size.
</summary>
<param name="baseOutputStream">
the output stream where deflated output should be written.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Deflater)">
<summary>
Creates a new DeflaterOutputStream with the given Deflater and
default buffer size.
</summary>
<param name="baseOutputStream">
the output stream where deflated output should be written.
</param>
<param name="deflater">
the underlying deflater.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Deflater,System.Int32)">
<summary>
Creates a new DeflaterOutputStream with the given Deflater and
buffer size.
</summary>
<param name="baseOutputStream">
The output stream where deflated output is written.
</param>
<param name="deflater">
The underlying deflater to use
</param>
<param name="bufferSize">
The buffer size to use when deflating
</param>
<exception cref="T:System.ArgumentOutOfRangeException">
bufsize is less than or equal to zero.
</exception>
<exception cref="T:System.ArgumentException">
baseOutputStream does not support writing
</exception>
<exception cref="T:System.ArgumentNullException">
deflater instance is null
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Finish">
<summary>
Finishes the stream by calling finish() on the deflater.
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
Not all input is deflated
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.EncryptBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Encrypt a block of data
</summary>
<param name="buffer">
Data to encrypt. NOTE the original contents of the buffer are lost
</param>
<param name="offset">
Offset of first byte in buffer to encrypt
</param>
<param name="length">
Number of bytes in buffer to encrypt
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.InitializePassword(System.String)">
<summary>
Initializes encryption keys based on given password
</summary>
<param name="password">The password.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Deflate">
<summary>
Deflates everything in the input buffers. This will call
<code>def.deflate()</code> until all bytes from the input buffers
are processed.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the current position of this stream to the given value. Not supported by this class!
</summary>
<param name="offset">The offset relative to the <paramref name="origin"/> to seek.</param>
<param name="origin">The <see cref="T:System.IO.SeekOrigin"/> to seek from.</param>
<returns>The new position in the stream.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.SetLength(System.Int64)">
<summary>
Sets the length of this stream to the given value. Not supported by this class!
</summary>
<param name="value">The new stream length.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.ReadByte">
<summary>
Read a byte from stream advancing position by one
</summary>
<returns>The byte read cast to an int. THe value is -1 if at the end of the stream.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read a block of bytes from stream
</summary>
<param name="buffer">The buffer to store read data in.</param>
<param name="offset">The offset to start storing at.</param>
<param name="count">The maximum number of bytes to read.</param>
<returns>The actual number of bytes read. Zero if end of stream is detected.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
<summary>
Asynchronous reads are not supported a NotSupportedException is always thrown
</summary>
<param name="buffer">The buffer to read into.</param>
<param name="offset">The offset to start storing data at.</param>
<param name="count">The number of bytes to read</param>
<param name="callback">The async callback to use.</param>
<param name="state">The state to use.</param>
<returns>Returns an <see cref="T:System.IAsyncResult"/></returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
<summary>
Asynchronous writes arent supported, a NotSupportedException is always thrown
</summary>
<param name="buffer">The buffer to write.</param>
<param name="offset">The offset to begin writing at.</param>
<param name="count">The number of bytes to write.</param>
<param name="callback">The <see cref="T:System.AsyncCallback"/> to use.</param>
<param name="state">The state object.</param>
<returns>Returns an IAsyncResult.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">
<summary>
Flushes the stream by calling <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">Flush</see> on the deflater and then
on the underlying stream. This ensures that all bytes are flushed.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Close">
<summary>
Calls <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Finish"/> and closes the underlying
stream when <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.IsStreamOwner"></see> is true.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.WriteByte(System.Byte)">
<summary>
Writes a single byte to the compressed output stream.
</summary>
<param name="value">
The byte value.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes bytes from an array to the compressed stream.
</summary>
<param name="buffer">
The byte array
</param>
<param name="offset">
The offset into the byte array where to start.
</param>
<param name="count">
The number of bytes to write.
</param>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.buffer_">
<summary>
This buffer is used temporarily to retrieve the bytes from the
deflater and write them to the underlying output stream.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.deflater_">
<summary>
The deflater which is used to deflate the stream.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.baseOutputStream_">
<summary>
Base stream the deflater depends on.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.IsStreamOwner">
<summary>
Get/set flag indicating ownership of the underlying stream.
When the flag is true <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Close"></see> will close the underlying stream also.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanPatchEntries">
<summary>
Allows client to determine if an entry can be patched after its added
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Password">
<summary>
Get/set the password used for encryption.
</summary>
<remarks>When set to null or if the password is empty no encryption is performed</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanRead">
<summary>
Gets value indicating stream can be read from
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanSeek">
<summary>
Gets a value indicating if seeking is supported for this stream
This property always returns false
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanWrite">
<summary>
Get value indicating if this stream supports writing
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Length">
<summary>
Get current length of stream
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Position">
<summary>
Gets the current position within the stream.
</summary>
<exception cref="T:System.NotSupportedException">Any attempt to set position</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.#ctor(System.IO.Stream)">
<summary>
Creates a new Zip output stream, writing a zip archive.
</summary>
<param name="baseOutputStream">
The output stream to which the archive contents are written.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.SetComment(System.String)">
<summary>
Set the zip file comment.
</summary>
<param name="comment">
The comment text for the entire archive.
</param>
<exception name ="ArgumentOutOfRangeException">
The converted comment is longer than 0xffff bytes.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.SetLevel(System.Int32)">
<summary>
Sets the compression level. The new level will be activated
immediately.
</summary>
<param name="level">The new compression level (1 to 9).</param>
<exception cref="T:System.ArgumentOutOfRangeException">
Level specified is not supported.
</exception>
<see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.GetLevel">
<summary>
Get the current deflater compression level
</summary>
<returns>The current compression level</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeShort(System.Int32)">
<summary>
Write an unsigned short in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeInt(System.Int32)">
<summary>
Write an int in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeLong(System.Int64)">
<summary>
Write an int in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.PutNextEntry(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Starts a new Zip entry. It automatically closes the previous
entry if present.
All entry elements bar name are optional, but must be correct if present.
If the compression method is stored and the output is not patchable
the compression for that entry is automatically changed to deflate level 0
</summary>
<param name="entry">
the entry.
</param>
<exception cref="T:System.ArgumentNullException">
if entry passed is null.
</exception>
<exception cref="T:System.IO.IOException">
if an I/O error occured.
</exception>
<exception cref="T:System.InvalidOperationException">
if stream was finished
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
Too many entries in the Zip file<br/>
Entry name is too long<br/>
Finish has already been called<br/>
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.CloseEntry">
<summary>
Closes the current entry, updating header and footer information as required
</summary>
<exception cref="T:System.IO.IOException">
An I/O error occurs.
</exception>
<exception cref="T:System.InvalidOperationException">
No entry is active.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes the given buffer to the current entry.
</summary>
<param name="buffer">The buffer containing data to write.</param>
<param name="offset">The offset of the first byte to write.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">Archive size is invalid</exception>
<exception cref="T:System.InvalidOperationException">No entry is active.</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Finish">
<summary>
Finishes the stream. This will write the central directory at the
end of the zip file and flush the stream.
</summary>
<remarks>
This is automatically called when the stream is closed.
</remarks>
<exception cref="T:System.IO.IOException">
An I/O error occurs.
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
Comment exceeds the maximum length<br/>
Entry name exceeds the maximum length
</exception>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.entries">
<summary>
The entries for the archive.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.crc">
<summary>
Used to track the crc of data added to entries.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.curEntry">
<summary>
The current entry being added.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.size">
<summary>
Used to track the size of data for an entry during writing.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.offset">
<summary>
Offset to be recorded for each entry in the central header.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.zipComment">
<summary>
Comment for the entire archive recorded in central header.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.patchEntryHeader">
<summary>
Flag indicating that header patching is required for the current entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.crcPatchPos">
<summary>
Position to patch crc
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.sizePatchPos">
<summary>
Position to patch size.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.IsFinished">
<summary>
Gets a flag value of true if the central header has been added for this archive; false if it has not been added.
</summary>
<remarks>No further entries can be added once this has been done.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.UseZip64">
<summary>
Get / set a value indicating how Zip64 Extension usage is determined when adding entries.
</summary>
<remarks>Older archivers may not understand Zip64 extensions.
If backwards compatability is an issue be careful when adding <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Size">entries</see> to an archive.
Setting this property to off is workable but less desirable as in those circumstances adding a file
larger then 4GB will fail.</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.INameTransform">
<summary>
INameTransform defines how file system names are transformed for use with archives.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.INameTransform.TransformFile(System.String)">
<summary>
Given a file name determine the transformed value.
</summary>
<param name="name">The name to transform.</param>
<returns>The transformed file name.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.INameTransform.TransformDirectory(System.String)">
<summary>
Given a directory name determine the transformed value.
</summary>
<param name="name">The name to transform.</param>
<returns>The transformed directory name</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants">
<summary>
This class contains constants used for deflation.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEBUGGING">
<summary>
Set to true to enable debugging
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.STORED_BLOCK">
<summary>
Written to Zip file to identify a stored block
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.STATIC_TREES">
<summary>
Identifies static tree in Zip file
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DYN_TREES">
<summary>
Identifies dynamic tree in Zip file
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.PRESET_DICT">
<summary>
Header flag indicating a preset dictionary for deflation
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFAULT_MEM_LEVEL">
<summary>
Sets internal buffer sizes for Huffman encoding
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_MATCH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MIN_MATCH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_WBITS">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.WSIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.WMASK">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_BITS">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_SIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_MASK">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_SHIFT">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MIN_LOOKAHEAD">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_DIST">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.PENDING_BUF_SIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_STORED">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_FAST">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_SLOW">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_BLOCK_SIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.GOOD_LENGTH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_LAZY">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.NICE_LENGTH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_CHAIN">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.COMPR_FUNC">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending">
<summary>
This class stores the pending output of the Deflater.
author of the original java version : Jochen Hoenicke
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending.#ctor">
<summary>
Construct instance with default buffer size
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.PathFilter">
<summary>
PathFilter filters directories and files using a form of <see cref="T:System.Text.RegularExpressions.Regex">regular expressions</see>
by full path name.
See <see cref="T:ICSharpCode.SharpZipLib.Core.NameFilter">NameFilter</see> for more detail on filtering.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.PathFilter.#ctor(System.String)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter"></see>.
</summary>
<param name="filter">The <see cref="T:ICSharpCode.SharpZipLib.Core.NameFilter">filter</see> expression to apply.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.PathFilter.IsMatch(System.String)">
<summary>
Test a name to see if it matches the filter.
</summary>
<param name="name">The name to test.</param>
<returns>True if the name matches, false otherwise.</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter">
<summary>
ExtendedPathFilter filters based on name, file size, and the last write time of the file.
</summary>
<remarks>Provides an example of how to customise filtering.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.#ctor(System.String,System.Int64,System.Int64)">
<summary>
Initialise a new instance of ExtendedPathFilter.
</summary>
<param name="filter">The filter to apply.</param>
<param name="minSize">The minimum file size to include.</param>
<param name="maxSize">The maximum file size to include.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.#ctor(System.String,System.DateTime,System.DateTime)">
<summary>
Initialise a new instance of ExtendedPathFilter.
</summary>
<param name="filter">The filter to apply.</param>
<param name="minDate">The minimum <see cref="T:System.DateTime"/> to include.</param>
<param name="maxDate">The maximum <see cref="T:System.DateTime"/> to include.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.#ctor(System.String,System.Int64,System.Int64,System.DateTime,System.DateTime)">
<summary>
Initialise a new instance of ExtendedPathFilter.
</summary>
<param name="filter">The filter to apply.</param>
<param name="minSize">The minimum file size to include.</param>
<param name="maxSize">The maximum file size to include.</param>
<param name="minDate">The minimum <see cref="T:System.DateTime"/> to include.</param>
<param name="maxDate">The maximum <see cref="T:System.DateTime"/> to include.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.IsMatch(System.String)">
<summary>
Test a filename to see if it matches the filter.
</summary>
<param name="name">The filename to test.</param>
<returns>True if the filter matches, false otherwise.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MinSize">
<summary>
Get/set the minimum size for a file that will match this filter.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MaxSize">
<summary>
Get/set the maximum size for a file that will match this filter.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MinDate">
<summary>
Get/set the minimum <see cref="T:System.DateTime"/> value that will match for this filter.
</summary>
<remarks>Files with a LastWrite time less than this value are excluded by the filter.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MaxDate">
<summary>
Get/set the maximum <see cref="T:System.DateTime"/> value that will match for this filter.
</summary>
<remarks>Files with a LastWrite time greater than this value are excluded by the filter.</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter">
<summary>
NameAndSizeFilter filters based on name and file size.
</summary>
<remarks>A sample showing how filters might be extended.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.#ctor(System.String,System.Int64,System.Int64)">
<summary>
Initialise a new instance of NameAndSizeFilter.
</summary>
<param name="filter">The filter to apply.</param>
<param name="minSize">The minimum file size to include.</param>
<param name="maxSize">The maximum file size to include.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.IsMatch(System.String)">
<summary>
Test a filename to see if it matches the filter.
</summary>
<param name="name">The filename to test.</param>
<returns>True if the filter matches, false otherwise.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.MinSize">
<summary>
Get/set the minimum size for a file that will match this filter.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.MaxSize">
<summary>
Get/set the maximum size for a file that will match this filter.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2Exception">
<summary>
BZip2Exception represents exceptions specific to Bzip2 algorithm
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Deserialization constructor
</summary>
<param name="info"><see cref="T:System.Runtime.Serialization.SerializationInfo"/> for this constructor</param>
<param name="context"><see cref="T:System.Runtime.Serialization.StreamingContext"/> for this constructor</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor">
<summary>
Initialise a new instance of BZip2Exception.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor(System.String)">
<summary>
Initialise a new instance of BZip2Exception with its message set to message.
</summary>
<param name="message">The message describing the error.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor(System.String,System.Exception)">
<summary>
Initialise an instance of BZip2Exception
</summary>
<param name="message">A message describing the error.</param>
<param name="exception">The exception that is the cause of the current exception.</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.GZip.GZipException">
<summary>
GZipException represents a Gzip specific exception
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Deserialization constructor
</summary>
<param name="info"><see cref="T:System.Runtime.Serialization.SerializationInfo"/> for this constructor</param>
<param name="context"><see cref="T:System.Runtime.Serialization.StreamingContext"/> for this constructor</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor">
<summary>
Initialise a new instance of GZipException
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor(System.String)">
<summary>
Initialise a new instance of GZipException with its message string.
</summary>
<param name="message">A <see cref="T:System.String"/> that describes the error.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor(System.String,System.Exception)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.GZip.GZipException"></see>.
</summary>
<param name="message">A <see cref="T:System.String"/> that describes the error.</param>
<param name="innerException">The <see cref="T:System.Exception"/> that caused this exception.</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow">
<summary>
Contains the output from the Inflation process.
We need to have a window so that we can refer backwards into the output stream
to repeat stuff.<br/>
Author of the original java version : John Leuner
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Write(System.Int32)">
<summary>
Write a byte to this output window
</summary>
<param name="value">value to write</param>
<exception cref="T:System.InvalidOperationException">
if window is full
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Repeat(System.Int32,System.Int32)">
<summary>
Append a byte pattern already in the window itself
</summary>
<param name="length">length of pattern to copy</param>
<param name="distance">distance from end of window pattern occurs</param>
<exception cref="T:System.InvalidOperationException">
If the repeated data overflows the window
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyStored(ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator,System.Int32)">
<summary>
Copy from input manipulator to internal window
</summary>
<param name="input">source of data</param>
<param name="length">length of data to copy</param>
<returns>the number of bytes copied</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyDict(System.Byte[],System.Int32,System.Int32)">
<summary>
Copy dictionary to window
</summary>
<param name="dictionary">source dictionary</param>
<param name="offset">offset of start in source dictionary</param>
<param name="length">length of dictionary</param>
<exception cref="T:System.InvalidOperationException">
If window isnt empty
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetFreeSpace">
<summary>
Get remaining unfilled space in window
</summary>
<returns>Number of bytes left in window</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetAvailable">
<summary>
Get bytes available for output in window
</summary>
<returns>Number of bytes filled</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyOutput(System.Byte[],System.Int32,System.Int32)">
<summary>
Copy contents of window to output
</summary>
<param name="output">buffer to copy to</param>
<param name="offset">offset to start at</param>
<param name="len">number of bytes to count</param>
<returns>The number of bytes copied</returns>
<exception cref="T:System.InvalidOperationException">
If a window underflow occurs
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Reset">
<summary>
Reset by clearing window so <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetAvailable">GetAvailable</see> returns 0
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2Constants">
<summary>
Defines internal values for both compression and decompression
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.baseBlockSize">
<summary>
When multiplied by compression parameter (1-9) gives the block size for compression
9 gives the best compresssion but uses the most memory.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.MAX_ALPHA_SIZE">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.MAX_CODE_LEN">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.RUNA">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.RUNB">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.N_GROUPS">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.G_SIZE">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.N_ITERS">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.MAX_SELECTORS">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.NUM_OVERSHOOT_BYTES">
<summary>
Backend constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.rNums">
<summary>
Random numbers used to randomise repetitive blocks
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.GZip.GZipOutputStream">
<summary>
This filter stream is used to compress a stream into a "GZIP" stream.
The "GZIP" format is described in RFC 1952.
author of the original java version : John Leuner
</summary>
<example> This sample shows how to gzip a file
<code>
using System;
using System.IO;
using ICSharpCode.SharpZipLib.GZip;
using ICSharpCode.SharpZipLib.Core;
class MainClass
{
public static void Main(string[] args)
{
using (Stream s = new GZipOutputStream(File.Create(args[0] + ".gz")))
using (FileStream fs = File.OpenRead(args[0])) {
byte[] writeData = new byte[4096];
Streamutils.Copy(s, fs, writeData);
}
}
}
}
</code>
</example>
</member>
<member name="F:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.crc">
<summary>
CRC-32 value for uncompressed data
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.#ctor(System.IO.Stream)">
<summary>
Creates a GzipOutputStream with the default buffer size
</summary>
<param name="baseOutputStream">
The stream to read data (to be compressed) from
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Creates a GZipOutputStream with the specified buffer size
</summary>
<param name="baseOutputStream">
The stream to read data (to be compressed) from
</param>
<param name="size">
Size of the buffer to use
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.SetLevel(System.Int32)">
<summary>
Sets the active compression level (1-9). The new level will be activated
immediately.
</summary>
<param name="level">The compression level to set.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
Level specified is not supported.
</exception>
<see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.GetLevel">
<summary>
Get the current compression level.
</summary>
<returns>The current compression level.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write given buffer to output updating crc
</summary>
<param name="buffer">Buffer to write</param>
<param name="offset">Offset of first byte in buf to write</param>
<param name="count">Number of bytes to write</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Close">
<summary>
Writes remaining compressed output data to the output stream
and closes it.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Finish">
<summary>
Finish compression and write any footer information required to stream
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs">
<summary>
Arguments used with KeysRequiredEvent
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.#ctor(System.String)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs"></see>
</summary>
<param name="name">The name of the file for which keys are required.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.#ctor(System.String,System.Byte[])">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs"></see>
</summary>
<param name="name">The name of the file for which keys are required.</param>
<param name="keyValue">The current key value.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.FileName">
<summary>
Get the name of the file for which keys are required.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.Key">
<summary>
Get/set the key value
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.TestStrategy">
<summary>
The strategy to apply to testing.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestStrategy.FindFirstError">
<summary>
Find the first error only.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestStrategy.FindAllErrors">
<summary>
Find all possible errors.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.TestOperation">
<summary>
The operation in progress reported by a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler"/> during testing.
</summary>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean)">TestArchive</seealso>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.Initialising">
<summary>
Setting up testing.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.EntryHeader">
<summary>
Testing an individual entries header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.EntryData">
<summary>
Testing an individual entries data
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.EntryComplete">
<summary>
Testing an individual entry has completed.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.MiscellaneousTests">
<summary>
Running miscellaneous tests
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.Complete">
<summary>
Testing is complete
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.TestStatus">
<summary>
Status returned returned by <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler"/> during testing.
</summary>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean)">TestArchive</seealso>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.TestStatus.#ctor(ICSharpCode.SharpZipLib.Zip.ZipFile)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.TestStatus"/>
</summary>
<param name="file">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> this status applies to.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.Operation">
<summary>
Get the current <see cref="T:ICSharpCode.SharpZipLib.Zip.TestOperation"/> in progress.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.File">
<summary>
Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> this status is applicable to.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.Entry">
<summary>
Get the current/last entry tested.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.ErrorCount">
<summary>
Get the number of errors detected so far.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.BytesTested">
<summary>
Get the number of bytes tested so far for the current entry.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.EntryValid">
<summary>
Get a value indicating wether the last entry test was valid.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler">
<summary>
Delegate invoked during <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean,ICSharpCode.SharpZipLib.Zip.TestStrategy,ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler)">testing</see> if supplied indicating current progress and status.
</summary>
<remarks>If the message is non-null an error has occured. If the message is null
the operation as found in <see cref="T:ICSharpCode.SharpZipLib.Zip.TestStatus">status</see> has started.</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.FileUpdateMode">
<summary>
The possible ways of <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate">applying updates</see> to an archive.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FileUpdateMode.Safe">
<summary>
Perform all updates on temporary files ensuring that the original file is saved.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.FileUpdateMode.Direct">
<summary>
Update the archive directly, which is faster but less safe.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile">
<summary>
This class represents a Zip archive. You can ask for the contained
entries, or get an input stream for a file entry. The entry is
automatically decompressed.
You can also update the archive adding or deleting entries.
This class is thread safe for input: You can open input streams for arbitrary
entries in different threads.
<br/>
<br/>Author of the original java version : Jochen Hoenicke
</summary>
<example>
<code>
using System;
using System.Text;
using System.Collections;
using System.IO;
using ICSharpCode.SharpZipLib.Zip;
class MainClass
{
static public void Main(string[] args)
{
using (ZipFile zFile = new ZipFile(args[0])) {
Console.WriteLine("Listing of : " + zFile.Name);
Console.WriteLine("");
Console.WriteLine("Raw Size Size Date Time Name");
Console.WriteLine("-------- -------- -------- ------ ---------");
foreach (ZipEntry e in zFile) {
if ( e.IsFile ) {
DateTime d = e.DateTime;
Console.WriteLine("{0, -10}{1, -10}{2} {3} {4}", e.Size, e.CompressedSize,
d.ToString("dd-MM-yy"), d.ToString("HH:mm"),
e.Name);
}
}
}
}
}
</code>
</example>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipFile.KeysRequired">
<summary>
Event handler for handling encryption keys.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.OnKeysRequired(System.String)">
<summary>
Handles getting of encryption keys when required.
</summary>
<param name="fileName">The file for which encryption keys are required.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.String)">
<summary>
Opens a Zip file with the given name for reading.
</summary>
<param name="name">The name of the file to open.</param>
<exception cref="T:System.IO.IOException">
An i/o error occurs
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The file doesn't contain a valid zip archive.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.IO.FileStream)">
<summary>
Opens a Zip file reading the given <see cref="T:System.IO.FileStream"/>.
</summary>
<param name="file">The <see cref="T:System.IO.FileStream"/> to read archive data from.</param>
<exception cref="T:System.IO.IOException">
An i/o error occurs.
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The file doesn't contain a valid zip archive.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.IO.Stream)">
<summary>
Opens a Zip file reading the given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream">The <see cref="T:System.IO.Stream"/> to read archive data from.</param>
<exception cref="T:System.IO.IOException">
An i/o error occurs
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The file doesn't contain a valid zip archive.<br/>
The stream provided cannot seek
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor">
<summary>
Initialises a default <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> instance with no entries and no file storage.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Finalize">
<summary>
Finalize this instance.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Close">
<summary>
Closes the ZipFile. If the stream is <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsStreamOwner">owned</see> then this also closes the underlying input stream.
Once closed, no further instance methods should be called.
</summary>
<exception cref="T:System.IO.IOException">
An i/o error occurs.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Create(System.String)">
<summary>
Create a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> whose data will be stored in a file.
</summary>
<param name="fileName">The name of the archive to create.</param>
<returns>Returns the newly created <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/></returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Create(System.IO.Stream)">
<summary>
Create a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> whose data will be stored on a stream.
</summary>
<param name="outStream">The stream providing data storage.</param>
<returns>Returns the newly created <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/></returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetEnumerator">
<summary>
Gets an enumerator for the Zip entries in this Zip file.
</summary>
<returns>Returns an <see cref="T:System.Collections.IEnumerator"/> for this archive.</returns>
<exception cref="T:System.InvalidOperationException">
The Zip file has been closed.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.FindEntry(System.String,System.Boolean)">
<summary>
Return the index of the entry with a matching name
</summary>
<param name="name">Entry name to find</param>
<param name="ignoreCase">If true the comparison is case insensitive</param>
<returns>The index position of the matching entry or -1 if not found</returns>
<exception cref="T:System.InvalidOperationException">
The Zip file has been closed.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetEntry(System.String)">
<summary>
Searches for a zip entry in this archive with the given name.
String comparisons are case insensitive
</summary>
<param name="name">
The name to find. May contain directory components separated by slashes ('/').
</param>
<returns>
A clone of the zip entry, or null if no entry with that name exists.
</returns>
<exception cref="T:System.InvalidOperationException">
The Zip file has been closed.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetInputStream(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Gets an input stream for reading the given zip entry data in an uncompressed form.
Normally the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> should be an entry returned by GetEntry().
</summary>
<param name="entry">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> to obtain a data <see cref="T:System.IO.Stream"/> for</param>
<returns>An input <see cref="T:System.IO.Stream"/> containing data for this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/></returns>
<exception cref="T:System.InvalidOperationException">
The ZipFile has already been closed
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The compression method for the entry is unknown
</exception>
<exception cref="T:System.IndexOutOfRangeException">
The entry is not found in the ZipFile
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetInputStream(System.Int64)">
<summary>
Creates an input stream reading a zip entry
</summary>
<param name="entryIndex">The index of the entry to obtain an input stream for.</param>
<returns>
An input <see cref="T:System.IO.Stream"/> containing data for this <paramref name="entryIndex"/>
</returns>
<exception cref="T:System.InvalidOperationException">
The ZipFile has already been closed
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The compression method for the entry is unknown
</exception>
<exception cref="T:System.IndexOutOfRangeException">
The entry is not found in the ZipFile
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean)">
<summary>
Test an archive for integrity/validity
</summary>
<param name="testData">Perform low level data Crc check</param>
<returns>true if all tests pass, false otherwise</returns>
<remarks>Testing will terminate on the first error found.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean,ICSharpCode.SharpZipLib.Zip.TestStrategy,ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler)">
<summary>
Test an archive for integrity/validity
</summary>
<param name="testData">Perform low level data Crc check</param>
<param name="strategy">The <see cref="T:ICSharpCode.SharpZipLib.Zip.TestStrategy"></see> to apply.</param>
<param name="resultHandler">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler"></see> handler to call during testing.</param>
<returns>true if all tests pass, false otherwise</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestLocalHeader(ICSharpCode.SharpZipLib.Zip.ZipEntry,ICSharpCode.SharpZipLib.Zip.ZipFile.HeaderTest)">
<summary>
Test a local header against that provided from the central directory
</summary>
<param name="entry">
The entry to test against
</param>
<param name="tests">The type of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.HeaderTest">tests</see> to carry out.</param>
<returns>The offset of the entries data in the file</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate(ICSharpCode.SharpZipLib.Zip.IArchiveStorage,ICSharpCode.SharpZipLib.Zip.IDynamicDataSource)">
<summary>
Begin updating this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> archive.
</summary>
<param name="archiveStorage">The <see cref="T:ICSharpCode.SharpZipLib.Zip.IArchiveStorage">archive storage</see> for use during the update.</param>
<param name="dataSource">The <see cref="T:ICSharpCode.SharpZipLib.Zip.IDynamicDataSource">data source</see> to utilise during updating.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate(ICSharpCode.SharpZipLib.Zip.IArchiveStorage)">
<summary>
Begin updating to this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> archive.
</summary>
<param name="archiveStorage">The storage to use during the update.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate">
<summary>
Begin updating this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> archive.
</summary>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate(ICSharpCode.SharpZipLib.Zip.IArchiveStorage)"/>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate"></seealso>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AbortUpdate"></seealso>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate">
<summary>
Commit current updates, updating this archive.
</summary>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate"></seealso>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AbortUpdate"></seealso>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AbortUpdate">
<summary>
Abort updating leaving the archive unchanged.
</summary>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate"></seealso>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate"></seealso>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.SetComment(System.String)">
<summary>
Set the file comment to be recorded when the current update is <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate">commited</see>.
</summary>
<param name="comment">The comment to record.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod,System.Boolean)">
<summary>
Add a new entry to the archive.
</summary>
<param name="fileName">The name of the file to add.</param>
<param name="compressionMethod">The compression method to use.</param>
<param name="useUnicodeText">Ensure Unicode text is used for name and comment for this entry.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
<summary>
Add a new entry to the archive.
</summary>
<param name="fileName">The name of the file to add.</param>
<param name="compressionMethod">The compression method to use.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(System.String)">
<summary>
Add a file to the archive.
</summary>
<param name="fileName">The name of the file to add.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.IStaticDataSource,System.String)">
<summary>
Add a file entry with data.
</summary>
<param name="dataSource">The source of the data for this entry.</param>
<param name="entryName">The name to give to the entry.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.IStaticDataSource,System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
<summary>
Add a file entry with data.
</summary>
<param name="dataSource">The source of the data for this entry.</param>
<param name="entryName">The name to give to the entry.</param>
<param name="compressionMethod">The compression method to use.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.IStaticDataSource,System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod,System.Boolean)">
<summary>
Add a file entry with data.
</summary>
<param name="dataSource">The source of the data for this entry.</param>
<param name="entryName">The name to give to the entry.</param>
<param name="compressionMethod">The compression method to use.</param>
<param name="useUnicodeText">Ensure Unicode text is used for name and comments for this entry.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Add a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> that contains no data.
</summary>
<param name="entry">The entry to add.</param>
<remarks>This can be used to add directories, volume labels, or empty file entries.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AddDirectory(System.String)">
<summary>
Add a directory entry to the archive.
</summary>
<param name="directoryName">The directory to add.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Delete(System.String)">
<summary>
Delete an entry by name
</summary>
<param name="fileName">The filename to delete</param>
<returns>True if the entry was found and deleted; false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Delete(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Delete a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> from the archive.
</summary>
<param name="entry">The entry to delete.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLEUshort(System.UInt16)">
<summary>
Write an unsigned short in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLEInt(System.Int32)">
<summary>
Write an int in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLEUint(System.UInt32)">
<summary>
Write an unsigned int in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLeLong(System.Int64)">
<summary>
Write a long in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetBuffer">
<summary>
Get a raw memory buffer.
</summary>
<returns>Returns a raw memory buffer.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetDescriptorSize(ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate)">
<summary>
Get the size of the source descriptor for a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate"/>.
</summary>
<param name="update">The update to get the size for.</param>
<returns>The descriptor size, zero if there isnt one.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetOutputStream(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Get an output stream for the specified <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/>
</summary>
<param name="entry">The entry to get an output stream for.</param>
<returns>The output stream obtained for the entry.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Dispose(System.Boolean)">
<summary>
Releases the unmanaged resources used by the this instance and optionally releases the managed resources.
</summary>
<param name="disposing">true to release both managed and unmanaged resources;
false to release only unmanaged resources.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ReadLEUshort">
<summary>
Read an unsigned short in little endian byte order.
</summary>
<returns>Returns the value read.</returns>
<exception cref="T:System.IO.EndOfStreamException">
The stream ends prematurely
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ReadLEUint">
<summary>
Read a uint in little endian byte order.
</summary>
<returns>Returns the value read.</returns>
<exception cref="T:System.IO.IOException">
An i/o error occurs.
</exception>
<exception cref="T:System.IO.EndOfStreamException">
The file ends prematurely
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ReadEntries">
<summary>
Search for and read the central directory of a zip file filling the entries array.
</summary>
<exception cref="T:System.IO.IOException">
An i/o error occurs.
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The central directory is malformed or cannot be found
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.LocateEntry(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Locate the data for a given entry.
</summary>
<returns>
The start offset of the data.
</returns>
<exception cref="T:System.IO.EndOfStreamException">
The stream ends prematurely
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The local header signature is invalid, the entry and central header file name lengths are different
or the local and entry compression methods dont match
</exception>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Key">
<summary>
Get/set the encryption key value.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Password">
<summary>
Password to be used for encrypting/decrypting files.
</summary>
<remarks>Set to null if no password is required.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.HaveKeys">
<summary>
Get a value indicating wether encryption keys are currently available.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsStreamOwner">
<summary>
Get/set a flag indicating if the underlying stream is owned by the ZipFile instance.
If the flag is true then the stream will be closed when <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Close">Close</see> is called.
</summary>
<remarks>
The default value is true in all cases.
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsEmbeddedArchive">
<summary>
Get a value indicating wether
this archive is embedded in another file or not.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsNewArchive">
<summary>
Get a value indicating that this archive is a new one.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipFileComment">
<summary>
Gets the comment for the zip file.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Name">
<summary>
Gets the name of this zip file.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Size">
<summary>
Gets the number of entries in this zip file.
</summary>
<exception cref="T:System.InvalidOperationException">
The Zip file has been closed.
</exception>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Count">
<summary>
Get the number of entries contained in this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/>.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.EntryByIndex(System.Int32)">
<summary>
Indexer property for ZipEntries
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.NameTransform">
<summary>
Get / set the <see cref="T:ICSharpCode.SharpZipLib.Core.INameTransform"/> to apply to names when updating.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.EntryFactory">
<summary>
Get/set the <see cref="T:ICSharpCode.SharpZipLib.Zip.IEntryFactory"/> used to generate <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> values
during updates.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.BufferSize">
<summary>
Get /set the buffer size to be used when updating this zip file.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsUpdating">
<summary>
Get a value indicating an update has <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate">been started</see>.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UseZip64">
<summary>
Get / set a value indicating how Zip64 Extension usage is determined when adding entries.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.KeysRequiredEventHandler">
<summary>
Delegate for handling keys/password setting during compresion/decompression.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UpdateCommand">
<summary>
The kind of update to apply.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UpdateComparer">
<summary>
Class used to sort updates.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UpdateComparer.Compare(System.Object,System.Object)">
<summary>
Compares two objects and returns a value indicating whether one is
less than, equal to or greater than the other.
</summary>
<param name="x">First object to compare</param>
<param name="y">Second object to compare.</param>
<returns>Compare result.</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate">
<summary>
Represents a pending update to a Zip file.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.#ctor(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Copy an existing entry.
</summary>
<param name="entry">The existing entry to copy.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.Entry">
<summary>
Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for this update.
</summary>
<remarks>This is the source or original entry.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.OutEntry">
<summary>
Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> that will be written to the updated/new file.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.Command">
<summary>
Get the command for this update.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.Filename">
<summary>
Get the filename if any for this update. Null if none exists.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.SizePatchOffset">
<summary>
Get/set the location of the size patch for this update.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.CrcPatchOffset">
<summary>
Get /set the location of the crc patch for this update.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString">
<summary>
Represents a string from a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> which is stored as an array of bytes.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.#ctor(System.String)">
<summary>
Initialise a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString"/> with a string.
</summary>
<param name="comment">The textual string form.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.#ctor(System.Byte[])">
<summary>
Initialise a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString"/> using a string in its binary 'raw' form.
</summary>
<param name="rawString"></param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.Reset">
<summary>
Reset the comment to its initial state.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.op_Implicit(ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString)~System.String">
<summary>
Implicit conversion of comment to a string.
</summary>
<param name="zipString">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString"/> to convert to a string.</param>
<returns>The textual equivalent for the input value.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.IsSourceString">
<summary>
Get a value indicating the original source of data for this instance.
True if the source was a string; false if the source was binary data.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.RawLength">
<summary>
Get the length of the comment when represented as raw bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.RawComment">
<summary>
Get the comment in its 'raw' form as plain bytes.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipEntryEnumerator">
<summary>
An <see cref="T:System.Collections.IEnumerator">enumerator</see> for <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">Zip entries</see>
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream">
<summary>
An <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream"/> is a stream that you can write uncompressed data
to and flush, but cannot read, seek or do anything else to.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Close">
<summary>
Close this stream instance.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Flush">
<summary>
Write any buffered data to underlying storage.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.CanRead">
<summary>
Gets a value indicating whether the current stream supports reading.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.CanWrite">
<summary>
Gets a value indicating whether the current stream supports writing.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Length">
<summary>
Get the length in bytes of the stream.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Position">
<summary>
Gets or sets the position within the current stream.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream">
<summary>
A <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream"/> is an <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream"/>
whose data is only a part or subsection of a file.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream">
<summary>
This filter stream is used to decompress data compressed using the "deflate"
format. The "deflate" format is described in RFC 1951.
This stream may form the basis for other decompression filters, such
as the <see cref="T:ICSharpCode.SharpZipLib.GZip.GZipInputStream">GZipInputStream</see>.
Author of the original java version : John Leuner.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream)">
<summary>
Create an InflaterInputStream with the default decompressor
and a default buffer size of 4KB.
</summary>
<param name = "baseInputStream">
The InputStream to read bytes from
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Inflater)">
<summary>
Create an InflaterInputStream with the specified decompressor
and a default buffer size of 4KB.
</summary>
<param name = "baseInputStream">
The source of input data
</param>
<param name = "inf">
The decompressor used to decompress data read from baseInputStream
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Inflater,System.Int32)">
<summary>
Create an InflaterInputStream with the specified decompressor
and the specified buffer size.
</summary>
<param name = "baseInputStream">
The InputStream to read bytes from
</param>
<param name = "inflater">
The decompressor to use
</param>
<param name = "bufferSize">
Size of the buffer to use
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Skip(System.Int64)">
<summary>
Skip specified number of bytes of uncompressed data
</summary>
<param name="count">
Number of bytes to skip
</param>
<returns>
The number of bytes skipped, zero if the end of
stream has been reached
</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
Number of bytes to skip is less than zero
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.StopDecrypting">
<summary>
Clear any cryptographic state.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Fill">
<summary>
Fills the buffer with more data to decompress.
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
Stream ends early
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Flush">
<summary>
Flushes the baseInputStream
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream
Always throws a NotSupportedException
</summary>
<param name="offset">The relative offset to seek to.</param>
<param name="origin">The <see cref="T:System.IO.SeekOrigin"/> defining where to seek from.</param>
<returns>The new position in the stream.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.SetLength(System.Int64)">
<summary>
Set the length of the current stream
Always throws a NotSupportedException
</summary>
<param name="value">The new length value for the stream.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes a sequence of bytes to stream and advances the current position
This method always throws a NotSupportedException
</summary>
<param name="buffer">Thew buffer containing data to write.</param>
<param name="offset">The offset of the first byte to write.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.WriteByte(System.Byte)">
<summary>
Writes one byte to the current stream and advances the current position
Always throws a NotSupportedException
</summary>
<param name="value">The byte to write.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>