1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.IO.Compression</name>
6 <member name="T:System.IO.Compression.ZipArchiveMode">
7 <summary>Specifies values for interacting with zip archive entries.</summary>
9 <member name="F:System.IO.Compression.ZipArchiveMode.Create">
10 <summary>Only creating new archive entries is permitted.</summary>
13 <member name="F:System.IO.Compression.ZipArchiveMode.Read">
14 <summary>Only reading archive entries is permitted.</summary>
17 <member name="F:System.IO.Compression.ZipArchiveMode.Update">
18 <summary>Both read and write operations are permitted for archive entries.</summary>
21 <member name="T:System.IO.Compression.ZipArchiveEntry">
22 <summary>Represents a compressed file within a zip archive.</summary>
24 <member name="P:System.IO.Compression.ZipArchiveEntry.Archive">
25 <summary>Gets the zip archive that the entry belongs to.</summary>
26 <returns>The zip archive that the entry belongs to, or <see langword="null"></see> if the entry has been deleted.</returns>
28 <member name="P:System.IO.Compression.ZipArchiveEntry.CompressedLength">
29 <summary>Gets the compressed size of the entry in the zip archive.</summary>
30 <returns>The compressed size of the entry in the zip archive.</returns>
31 <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
33 <member name="P:System.IO.Compression.ZipArchiveEntry.Crc32">
36 <member name="M:System.IO.Compression.ZipArchiveEntry.Delete">
37 <summary>Deletes the entry from the zip archive.</summary>
38 <exception cref="T:System.IO.IOException">The entry is already open for reading or writing.</exception>
39 <exception cref="T:System.NotSupportedException">The zip archive for this entry was opened in a mode other than <see cref="System.IO.Compression.ZipArchiveMode.Update"></see>.</exception>
40 <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
42 <member name="P:System.IO.Compression.ZipArchiveEntry.ExternalAttributes">
43 <summary>OS and application specific file attributes.</summary>
44 <returns>The external attributes written by the application when this entry was written. It is both host OS and application dependent.</returns>
46 <member name="P:System.IO.Compression.ZipArchiveEntry.FullName">
47 <summary>Gets the relative path of the entry in the zip archive.</summary>
48 <returns>The relative path of the entry in the zip archive.</returns>
50 <member name="P:System.IO.Compression.ZipArchiveEntry.LastWriteTime">
51 <summary>Gets or sets the last time the entry in the zip archive was changed.</summary>
52 <returns>The last time the entry in the zip archive was changed.</returns>
53 <exception cref="T:System.NotSupportedException">The attempt to set this property failed, because the zip archive for the entry is in <see cref="System.IO.Compression.ZipArchiveMode.Read"></see> mode.</exception>
54 <exception cref="T:System.IO.IOException">The archive mode is set to <see cref="System.IO.Compression.ZipArchiveMode.Create"></see>.
56 The archive mode is set to <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and the entry has been opened.</exception>
57 <exception cref="T:System.ArgumentOutOfRangeException">An attempt was made to set this property to a value that is either earlier than 1980 January 1 0:00:00 (midnight) or later than 2107 December 31 23:59:58 (one second before midnight).</exception>
59 <member name="P:System.IO.Compression.ZipArchiveEntry.Length">
60 <summary>Gets the uncompressed size of the entry in the zip archive.</summary>
61 <returns>The uncompressed size of the entry in the zip archive.</returns>
62 <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
64 <member name="P:System.IO.Compression.ZipArchiveEntry.Name">
65 <summary>Gets the file name of the entry in the zip archive.</summary>
66 <returns>The file name of the entry in the zip archive.</returns>
68 <member name="M:System.IO.Compression.ZipArchiveEntry.Open">
69 <summary>Opens the entry from the zip archive.</summary>
70 <returns>The stream that represents the contents of the entry.</returns>
71 <exception cref="T:System.IO.IOException">The entry is already currently open for writing.
73 The entry has been deleted from the archive.
75 The archive for this entry was opened with the <see cref="System.IO.Compression.ZipArchiveMode.Create"></see> mode, and this entry has already been written to.</exception>
76 <exception cref="T:System.IO.InvalidDataException">The entry is either missing from the archive or is corrupt and cannot be read.
78 The entry has been compressed by using a compression method that is not supported.</exception>
79 <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
81 <member name="M:System.IO.Compression.ZipArchiveEntry.ToString">
82 <summary>Retrieves the relative path of the entry in the zip archive.</summary>
83 <returns>The relative path of the entry, which is the value stored in the <see cref="P:System.IO.Compression.ZipArchiveEntry.FullName"></see> property.</returns>
85 <member name="T:System.IO.Compression.ZipArchive">
86 <summary>Represents a package of compressed files in the zip archive format.</summary>
88 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream)">
89 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class from the specified stream.</summary>
90 <param name="stream">The stream that contains the archive to be read.</param>
91 <exception cref="T:System.ArgumentException">The stream is already closed or does not support reading.</exception>
92 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
93 <exception cref="T:System.IO.InvalidDataException">The contents of the stream are not in the zip archive format.</exception>
95 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode)">
96 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class from the specified stream and with the specified mode.</summary>
97 <param name="stream">The input or output stream.</param>
98 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
99 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
100 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
101 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode">mode</paramref> is an invalid value.</exception>
102 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.
104 <paramref name="mode">mode</paramref> is <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and an entry is missing from the archive or is corrupt and cannot be read.
106 <paramref name="mode">mode</paramref> is <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and an entry is too large to fit into memory.</exception>
108 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean)">
109 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class on the specified stream for the specified mode, and optionally leaves the stream open.</summary>
110 <param name="stream">The input or output stream.</param>
111 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
112 <param name="leaveOpen"><see langword="true"></see> to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive"></see> object is disposed; otherwise, <see langword="false"></see>.</param>
113 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
114 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
115 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode">mode</paramref> is an invalid value.</exception>
116 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.
118 <paramref name="mode">mode</paramref> is <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and an entry is missing from the archive or is corrupt and cannot be read.
120 <paramref name="mode">mode</paramref> is <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and an entry is too large to fit into memory.</exception>
122 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean,System.Text.Encoding)">
123 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class on the specified stream for the specified mode, uses the specified encoding for entry names, and optionally leaves the stream open.</summary>
124 <param name="stream">The input or output stream.</param>
125 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
126 <param name="leaveOpen"><see langword="true"></see> to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive"></see> object is disposed; otherwise, <see langword="false"></see>.</param>
127 <param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param>
128 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
129 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
130 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode">mode</paramref> is an invalid value.</exception>
131 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.
133 <paramref name="mode">mode</paramref> is <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and an entry is missing from the archive or is corrupt and cannot be read.
135 <paramref name="mode">mode</paramref> is <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and an entry is too large to fit into memory.</exception>
137 <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String)">
138 <summary>Creates an empty entry that has the specified path and entry name in the zip archive.</summary>
139 <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
140 <returns>An empty entry in the zip archive.</returns>
141 <exception cref="T:System.ArgumentException"><paramref name="entryName">entryName</paramref> is <see cref="System.String.Empty"></see>.</exception>
142 <exception cref="T:System.ArgumentNullException"><paramref name="entryName">entryName</paramref> is <see langword="null"></see>.</exception>
143 <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
144 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
146 <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String,System.IO.Compression.CompressionLevel)">
147 <summary>Creates an empty entry that has the specified entry name and compression level in the zip archive.</summary>
148 <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
149 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
150 <returns>An empty entry in the zip archive.</returns>
151 <exception cref="T:System.ArgumentException"><paramref name="entryName">entryName</paramref> is <see cref="System.String.Empty"></see>.</exception>
152 <exception cref="T:System.ArgumentNullException"><paramref name="entryName">entryName</paramref> is <see langword="null"></see>.</exception>
153 <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
154 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
156 <member name="M:System.IO.Compression.ZipArchive.Dispose">
157 <summary>Releases the resources used by the current instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class.</summary>
159 <member name="M:System.IO.Compression.ZipArchive.Dispose(System.Boolean)">
160 <summary>Called by the <see cref="M:System.IO.Compression.ZipArchive.Dispose"></see> and <see cref="M:System.Object.Finalize"></see> methods to release the unmanaged resources used by the current instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class, and optionally finishes writing the archive and releases the managed resources.</summary>
161 <param name="disposing"><see langword="true"></see> to finish writing the archive and release unmanaged and managed resources; <see langword="false"></see> to release only unmanaged resources.</param>
163 <member name="P:System.IO.Compression.ZipArchive.Entries">
164 <summary>Gets the collection of entries that are currently in the zip archive.</summary>
165 <returns>The collection of entries that are currently in the zip archive.</returns>
166 <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
167 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
168 <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
170 <member name="M:System.IO.Compression.ZipArchive.GetEntry(System.String)">
171 <summary>Retrieves a wrapper for the specified entry in the zip archive.</summary>
172 <param name="entryName">A path, relative to the root of the archive, that identifies the entry to retrieve.</param>
173 <returns>A wrapper for the specified entry in the archive; <see langword="null"></see> if the entry does not exist in the archive.</returns>
174 <exception cref="T:System.ArgumentException"><paramref name="entryName">entryName</paramref> is <see cref="System.String.Empty"></see>.</exception>
175 <exception cref="T:System.ArgumentNullException"><paramref name="entryName">entryName</paramref> is <see langword="null"></see>.</exception>
176 <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
177 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
178 <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
180 <member name="P:System.IO.Compression.ZipArchive.Mode">
181 <summary>Gets a value that describes the type of action the zip archive can perform on entries.</summary>
182 <returns>One of the enumeration values that describes the type of action (read, create, or update) the zip archive can perform on entries.</returns>
184 <member name="T:System.IO.Compression.GZipStream">
185 <summary>Provides methods and properties used to compress and decompress streams.</summary>
187 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
188 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream"></see> class by using the specified stream and compression level.</summary>
189 <param name="stream">The stream to write the compressed data to.</param>
190 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
191 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
192 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="System.IO.Stream.CanWrite"></see> property on the stream object is <see langword="false"></see>.)</exception>
194 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
195 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream"></see> class by using the specified stream and compression mode.</summary>
196 <param name="stream">The stream the compressed or decompressed data is written to.</param>
197 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
198 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
199 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> enumeration value.
201 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Compress"></see> and <see cref="System.IO.Stream.CanWrite"></see> is <see langword="false"></see>.
203 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Decompress"></see> and <see cref="System.IO.Stream.CanRead"></see> is <see langword="false"></see>.</exception>
205 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
206 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream"></see> class by using the specified stream and compression level, and optionally leaves the stream open.</summary>
207 <param name="stream">The stream to write the compressed data to.</param>
208 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
209 <param name="leaveOpen"><see langword="true"></see> to leave the stream object open after disposing the <see cref="T:System.IO.Compression.GZipStream"></see> object; otherwise, <see langword="false"></see>.</param>
210 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
211 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="System.IO.Stream.CanWrite"></see> property on the stream object is <see langword="false"></see>.)</exception>
213 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
214 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream"></see> class by using the specified stream and compression mode, and optionally leaves the stream open.</summary>
215 <param name="stream">The stream the compressed or decompressed data is written to.</param>
216 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
217 <param name="leaveOpen"><see langword="true"></see> to leave the stream open after disposing the <see cref="T:System.IO.Compression.GZipStream"></see> object; otherwise, <see langword="false"></see>.</param>
218 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
219 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> value.
221 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Compress"></see> and <see cref="System.IO.Stream.CanWrite"></see> is <see langword="false"></see>.
223 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Decompress"></see> and <see cref="System.IO.Stream.CanRead"></see> is <see langword="false"></see>.</exception>
225 <member name="P:System.IO.Compression.GZipStream.BaseStream">
226 <summary>Gets a reference to the underlying stream.</summary>
227 <returns>A stream object that represents the underlying stream.</returns>
228 <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
230 <member name="M:System.IO.Compression.GZipStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
231 <summary>Begins an asynchronous read operation. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
232 <param name="array"></param>
233 <param name="offset">The byte offset in array at which to begin reading data from the stream.</param>
234 <param name="count">The maximum number of bytes to read.</param>
235 <param name="asyncCallback"></param>
236 <param name="asyncState"></param>
237 <returns>An object that represents the asynchronous read operation, which could still be pending.</returns>
238 <exception cref="T:System.IO.IOException">The method tried to read asynchronously past the end of the stream, or a disk error occurred.</exception>
239 <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
240 <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
241 <exception cref="T:System.NotSupportedException">The current <see cref="System.IO.Compression.GZipStream"></see> implementation does not support the read operation.</exception>
242 <exception cref="T:System.InvalidOperationException">A read operation cannot be performed because the stream is closed.</exception>
244 <member name="M:System.IO.Compression.GZipStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
245 <summary>Begins an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
246 <param name="array"></param>
247 <param name="offset">The byte offset in array at which to begin writing.</param>
248 <param name="count">The maximum number of bytes to write.</param>
249 <param name="asyncCallback"></param>
250 <param name="asyncState"></param>
251 <returns>An object that represents the asynchronous write operation, which could still be pending.</returns>
252 <exception cref="T:System.InvalidOperationException">The underlying stream is <see langword="null"></see>.
254 The underlying stream is closed.</exception>
256 <member name="P:System.IO.Compression.GZipStream.CanRead">
257 <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
258 <returns><see langword="true"></see> if the <see cref="T:System.IO.Compression.CompressionMode"></see> value is <see langword="Decompress,"></see> and the underlying stream supports reading and is not closed; otherwise, <see langword="false"></see>.</returns>
260 <member name="P:System.IO.Compression.GZipStream.CanSeek">
261 <summary>Gets a value indicating whether the stream supports seeking.</summary>
262 <returns><see langword="false"></see> in all cases.</returns>
264 <member name="P:System.IO.Compression.GZipStream.CanWrite">
265 <summary>Gets a value indicating whether the stream supports writing.</summary>
266 <returns><see langword="true"></see> if the <see cref="T:System.IO.Compression.CompressionMode"></see> value is <see langword="Compress"></see>, and the underlying stream supports writing and is not closed; otherwise, <see langword="false"></see>.</returns>
268 <member name="M:System.IO.Compression.GZipStream.Dispose(System.Boolean)">
269 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.GZipStream"></see> and optionally releases the managed resources.</summary>
270 <param name="disposing"><see langword="true"></see> to release both managed and unmanaged resources; <see langword="false"></see> to release only unmanaged resources.</param>
272 <member name="M:System.IO.Compression.GZipStream.EndRead(System.IAsyncResult)">
273 <summary>Waits for the pending asynchronous read to complete. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
274 <param name="asyncResult"></param>
275 <returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <see cref="T:System.IO.Compression.GZipStream"></see> returns 0 only at the end of the stream; otherwise, it blocks until at least one byte is available.</returns>
276 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is <see langword="null"></see>.</exception>
277 <exception cref="T:System.ArgumentException"><paramref name="asyncResult">asyncResult</paramref> did not originate from a <see cref="System.IO.Compression.DeflateStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"></see> method on the current stream.</exception>
278 <exception cref="T:System.InvalidOperationException">The end operation cannot be performed because the stream is closed.</exception>
280 <member name="M:System.IO.Compression.GZipStream.EndWrite(System.IAsyncResult)">
281 <summary>Handles the end of an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
282 <param name="asyncResult"></param>
283 <exception cref="T:System.InvalidOperationException">The underlying stream is <see langword="null"></see>.
285 The underlying stream is closed.</exception>
287 <member name="M:System.IO.Compression.GZipStream.Flush">
288 <summary>The current implementation of this method has no functionality.</summary>
289 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
291 <member name="P:System.IO.Compression.GZipStream.Length">
292 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
293 <returns>A long value.</returns>
294 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
296 <member name="P:System.IO.Compression.GZipStream.Position">
297 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
298 <returns>A long value.</returns>
299 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
301 <member name="M:System.IO.Compression.GZipStream.Read(System.Byte[],System.Int32,System.Int32)">
302 <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
303 <param name="array">The array used to store decompressed bytes.</param>
304 <param name="offset">The byte offset in array at which the read bytes will be placed.</param>
305 <param name="count">The maximum number of decompressed bytes to read.</param>
306 <returns>The number of bytes that were decompressed into the byte array. If the end of the stream has been reached, zero or the number of bytes read is returned.</returns>
307 <exception cref="T:System.ArgumentNullException"><paramref name="array">array</paramref> is <see langword="null"></see>.</exception>
308 <exception cref="T:System.InvalidOperationException">The <see cref="System.IO.Compression.CompressionMode"></see> value was <see langword="Compress"></see> when the object was created.
310 The underlying stream does not support reading.</exception>
311 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> or <paramref name="count">count</paramref> is less than zero.
313 <paramref name="array">array</paramref> length minus the index starting point is less than <paramref name="count">count</paramref>.</exception>
314 <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
315 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
317 <member name="M:System.IO.Compression.GZipStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
318 <param name="array"></param>
319 <param name="offset"></param>
320 <param name="count"></param>
321 <param name="cancellationToken"></param>
324 <member name="M:System.IO.Compression.GZipStream.Seek(System.Int64,System.IO.SeekOrigin)">
325 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
326 <param name="offset">The location in the stream.</param>
327 <param name="origin">One of the <see cref="T:System.IO.SeekOrigin"></see> values.</param>
328 <returns>A long value.</returns>
329 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
331 <member name="M:System.IO.Compression.GZipStream.SetLength(System.Int64)">
332 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
333 <param name="value">The length of the stream.</param>
334 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
336 <member name="M:System.IO.Compression.GZipStream.Write(System.Byte[],System.Int32,System.Int32)">
337 <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
338 <param name="array">The buffer that contains the data to compress.</param>
339 <param name="offset">The byte offset in array from which the bytes will be read.</param>
340 <param name="count">The maximum number of bytes to write.</param>
341 <exception cref="T:System.ObjectDisposedException">The write operation cannot be performed because the stream is closed.</exception>
343 <member name="M:System.IO.Compression.GZipStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
344 <param name="array"></param>
345 <param name="offset"></param>
346 <param name="count"></param>
347 <param name="cancellationToken"></param>
350 <member name="T:System.IO.Compression.DeflateStream">
351 <summary>Provides methods and properties for compressing and decompressing streams by using the Deflate algorithm.</summary>
353 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
354 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream"></see> class by using the specified stream and compression level.</summary>
355 <param name="stream">The stream to compress.</param>
356 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
357 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
358 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="System.IO.Stream.CanWrite"></see> property on the stream object is <see langword="false"></see>.)</exception>
360 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
361 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream"></see> class by using the specified stream and compression mode.</summary>
362 <param name="stream">The stream to compress or decompress.</param>
363 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
364 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
365 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> value.
367 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Compress"></see> and <see cref="System.IO.Stream.CanWrite"></see> is <see langword="false"></see>.
369 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Decompress"></see> and <see cref="System.IO.Stream.CanRead"></see> is <see langword="false"></see>.</exception>
371 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
372 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream"></see> class by using the specified stream and compression level, and optionally leaves the stream open.</summary>
373 <param name="stream">The stream to compress.</param>
374 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
375 <param name="leaveOpen"><see langword="true"></see> to leave the stream object open after disposing the <see cref="T:System.IO.Compression.DeflateStream"></see> object; otherwise, <see langword="false"></see>.</param>
376 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
377 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="System.IO.Stream.CanWrite"></see> property on the stream object is <see langword="false"></see>.)</exception>
379 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
380 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream"></see> class by using the specified stream and compression mode, and optionally leaves the stream open.</summary>
381 <param name="stream">The stream to compress or decompress.</param>
382 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
383 <param name="leaveOpen"><see langword="true"></see> to leave the stream open after disposing the <see cref="T:System.IO.Compression.DeflateStream"></see> object; otherwise, <see langword="false"></see>.</param>
384 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is <see langword="null"></see>.</exception>
385 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> value.
387 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Compress"></see> and <see cref="System.IO.Stream.CanWrite"></see> is <see langword="false"></see>.
389 <see cref="System.IO.Compression.CompressionMode"></see> is <see cref="System.IO.Compression.CompressionMode.Decompress"></see> and <see cref="System.IO.Stream.CanRead"></see> is <see langword="false"></see>.</exception>
391 <member name="P:System.IO.Compression.DeflateStream.BaseStream">
392 <summary>Gets a reference to the underlying stream.</summary>
393 <returns>A stream object that represents the underlying stream.</returns>
394 <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
396 <member name="M:System.IO.Compression.DeflateStream.BeginRead(System.Byte[],System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
397 <summary>Begins an asynchronous read operation. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
398 <param name="array"></param>
399 <param name="buffer"></param>
400 <param name="offset">The byte offset in array at which to begin reading data from the stream.</param>
401 <param name="count">The maximum number of bytes to read.</param>
402 <param name="asyncCallback"></param>
403 <param name="asyncState"></param>
404 <returns>An object that represents the asynchronous read operation, which could still be pending.</returns>
405 <exception cref="T:System.IO.IOException">The method tried to read asynchronously past the end of the stream, or a disk error occurred.</exception>
406 <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
407 <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
408 <exception cref="T:System.NotSupportedException">The current <see cref="System.IO.Compression.DeflateStream"></see> implementation does not support the read operation.</exception>
409 <exception cref="T:System.InvalidOperationException">This call cannot be completed.</exception>
411 <member name="M:System.IO.Compression.DeflateStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
412 <summary>Begins an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
413 <param name="array"></param>
414 <param name="offset">The byte offset in buffer to begin writing from.</param>
415 <param name="count">The maximum number of bytes to write.</param>
416 <param name="asyncCallback"></param>
417 <param name="asyncState"></param>
418 <returns>An object that represents the asynchronous write operation, which could still be pending.</returns>
419 <exception cref="T:System.IO.IOException">The method tried to write asynchronously past the end of the stream, or a disk error occurred.</exception>
420 <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
421 <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
422 <exception cref="T:System.NotSupportedException">The current <see cref="System.IO.Compression.DeflateStream"></see> implementation does not support the write operation.</exception>
423 <exception cref="T:System.InvalidOperationException">The write operation cannot be performed because the stream is closed.</exception>
425 <member name="P:System.IO.Compression.DeflateStream.CanRead">
426 <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
427 <returns><see langword="true"></see> if the <see cref="T:System.IO.Compression.CompressionMode"></see> value is <see langword="Decompress"></see>, and the underlying stream is opened and supports reading; otherwise, <see langword="false"></see>.</returns>
429 <member name="P:System.IO.Compression.DeflateStream.CanSeek">
430 <summary>Gets a value indicating whether the stream supports seeking.</summary>
431 <returns><see langword="false"></see> in all cases.</returns>
433 <member name="P:System.IO.Compression.DeflateStream.CanWrite">
434 <summary>Gets a value indicating whether the stream supports writing.</summary>
435 <returns><see langword="true"></see> if the <see cref="T:System.IO.Compression.CompressionMode"></see> value is <see langword="Compress"></see>, and the underlying stream supports writing and is not closed; otherwise, <see langword="false"></see>.</returns>
437 <member name="M:System.IO.Compression.DeflateStream.Dispose(System.Boolean)">
438 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.DeflateStream"></see> and optionally releases the managed resources.</summary>
439 <param name="disposing"><see langword="true"></see> to release both managed and unmanaged resources; <see langword="false"></see> to release only unmanaged resources.</param>
441 <member name="M:System.IO.Compression.DeflateStream.EndRead(System.IAsyncResult)">
442 <summary>Waits for the pending asynchronous read to complete. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
443 <param name="asyncResult"></param>
444 <returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <see cref="T:System.IO.Compression.DeflateStream"></see> returns 0 only at the end of the stream; otherwise, it blocks until at least one byte is available.</returns>
445 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is <see langword="null"></see>.</exception>
446 <exception cref="T:System.ArgumentException"><paramref name="asyncResult">asyncResult</paramref> did not originate from a <see cref="System.IO.Compression.DeflateStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"></see> method on the current stream.</exception>
447 <exception cref="T:System.SystemException">An exception was thrown during a call to <see cref="System.Threading.WaitHandle.WaitOne"></see>.</exception>
448 <exception cref="T:System.InvalidOperationException">The stream is <see langword="null"></see>.</exception>
450 <member name="M:System.IO.Compression.DeflateStream.EndWrite(System.IAsyncResult)">
451 <summary>Ends an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)"></see> method instead.)</summary>
452 <param name="asyncResult"></param>
453 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is <see langword="null"></see>.</exception>
454 <exception cref="T:System.ArgumentException"><paramref name="asyncResult">asyncResult</paramref> did not originate from a <see cref="System.IO.Compression.DeflateStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"></see> method on the current stream.</exception>
455 <exception cref="T:System.Exception">An exception was thrown during a call to <see cref="System.Threading.WaitHandle.WaitOne"></see>.</exception>
456 <exception cref="T:System.InvalidOperationException">The end write call is invalid.</exception>
458 <member name="M:System.IO.Compression.DeflateStream.Flush">
459 <summary>The current implementation of this method has no functionality.</summary>
460 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
462 <member name="P:System.IO.Compression.DeflateStream.Length">
463 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
464 <returns>A long value.</returns>
465 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
467 <member name="P:System.IO.Compression.DeflateStream.Position">
468 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
469 <returns>A long value.</returns>
470 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
472 <member name="M:System.IO.Compression.DeflateStream.Read(System.Byte[],System.Int32,System.Int32)">
473 <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
474 <param name="array">The array to store decompressed bytes.</param>
475 <param name="offset">The byte offset in array at which the read bytes will be placed.</param>
476 <param name="count">The maximum number of decompressed bytes to read.</param>
477 <returns>The number of bytes that were read into the byte array.</returns>
478 <exception cref="T:System.ArgumentNullException"><paramref name="array">array</paramref> is <see langword="null"></see>.</exception>
479 <exception cref="T:System.InvalidOperationException">The <see cref="System.IO.Compression.CompressionMode"></see> value was <see langword="Compress"></see> when the object was created.
481 The underlying stream does not support reading.</exception>
482 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> or <paramref name="count">count</paramref> is less than zero.
484 <paramref name="array">array</paramref> length minus the index starting point is less than <paramref name="count">count</paramref>.</exception>
485 <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
486 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
488 <member name="M:System.IO.Compression.DeflateStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
489 <param name="array"></param>
490 <param name="offset"></param>
491 <param name="count"></param>
492 <param name="cancellationToken"></param>
495 <member name="M:System.IO.Compression.DeflateStream.Seek(System.Int64,System.IO.SeekOrigin)">
496 <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
497 <param name="offset">The location in the stream.</param>
498 <param name="origin">One of the <see cref="T:System.IO.SeekOrigin"></see> values.</param>
499 <returns>A long value.</returns>
500 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
502 <member name="M:System.IO.Compression.DeflateStream.SetLength(System.Int64)">
503 <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
504 <param name="value">The length of the stream.</param>
505 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
507 <member name="M:System.IO.Compression.DeflateStream.Write(System.Byte[],System.Int32,System.Int32)">
508 <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
509 <param name="array">The buffer that contains the data to compress.</param>
510 <param name="offset">The byte offset in array from which the bytes will be read.</param>
511 <param name="count">The maximum number of bytes to write.</param>
513 <member name="M:System.IO.Compression.DeflateStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
514 <param name="array"></param>
515 <param name="offset"></param>
516 <param name="count"></param>
517 <param name="cancellationToken"></param>
520 <member name="T:System.IO.Compression.CompressionMode">
521 <summary>Specifies whether to compress or decompress the underlying stream.</summary>
523 <member name="F:System.IO.Compression.CompressionMode.Compress">
524 <summary>Compresses the underlying stream.</summary>
527 <member name="F:System.IO.Compression.CompressionMode.Decompress">
528 <summary>Decompresses the underlying stream.</summary>
531 <member name="T:System.IO.Compression.CompressionLevel">
532 <summary>Specifies values that indicate whether a compression operation emphasizes speed or compression size.</summary>
534 <member name="F:System.IO.Compression.CompressionLevel.Fastest">
535 <summary>The compression operation should complete as quickly as possible, even if the resulting file is not optimally compressed.</summary>
538 <member name="F:System.IO.Compression.CompressionLevel.NoCompression">
539 <summary>No compression should be performed on the file.</summary>
542 <member name="F:System.IO.Compression.CompressionLevel.Optimal">
543 <summary>The compression operation should be optimally compressed, even if the operation takes a longer time to complete.</summary>