1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.IO.Compression</name>
6 <member name="T:System.IO.Compression.CompressionLevel">
7 <summary>Specifies values that indicate whether a compression operation emphasizes speed or compression size.</summary>
9 <member name="F:System.IO.Compression.CompressionLevel.Fastest">
10 <summary>The compression operation should complete as quickly as possible, even if the resulting file is not optimally compressed.</summary>
13 <member name="F:System.IO.Compression.CompressionLevel.NoCompression">
14 <summary>No compression should be performed on the file.</summary>
17 <member name="F:System.IO.Compression.CompressionLevel.Optimal">
18 <summary>The compression operation should be optimally compressed, even if the operation takes a longer time to complete.</summary>
21 <member name="T:System.IO.Compression.CompressionMode">
22 <summary>Specifies whether to compress or decompress the underlying stream.</summary>
24 <member name="F:System.IO.Compression.CompressionMode.Compress">
25 <summary>Compresses the underlying stream.</summary>
28 <member name="F:System.IO.Compression.CompressionMode.Decompress">
29 <summary>Decompresses the underlying stream.</summary>
32 <member name="T:System.IO.Compression.DeflateStream">
33 <summary>Provides methods and properties for compressing and decompressing streams by using the Deflate algorithm.</summary>
35 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
36 <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>
37 <param name="stream">The stream to compress.</param>
38 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
39 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
40 <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 false.)</exception>
42 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
43 <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>
44 <param name="stream">The stream to compress or decompress.</param>
45 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
46 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
47 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> value.
49 <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 false.
51 <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 false.</exception>
53 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
54 <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>
55 <param name="stream">The stream to compress.</param>
56 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
57 <param name="leaveOpen">true to leave the stream object open after disposing the <see cref="T:System.IO.Compression.DeflateStream"></see> object; otherwise, false.</param>
58 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
59 <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 false.)</exception>
61 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
62 <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>
63 <param name="stream">The stream to compress or decompress.</param>
64 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
65 <param name="leaveOpen">true to leave the stream open after disposing the <see cref="T:System.IO.Compression.DeflateStream"></see> object; otherwise, false.</param>
66 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
67 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> value.
69 <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 false.
71 <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 false.</exception>
73 <member name="P:System.IO.Compression.DeflateStream.BaseStream">
74 <summary>Gets a reference to the underlying stream.</summary>
75 <returns>A stream object that represents the underlying stream.</returns>
76 <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
78 <member name="M:System.IO.Compression.DeflateStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
79 <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>
80 <param name="array"></param>
81 <param name="offset">The byte offset in array at which to begin reading data from the stream.</param>
82 <param name="count">The maximum number of bytes to read.</param>
83 <param name="asyncCallback"></param>
84 <param name="asyncState"></param>
85 <returns>An object that represents the asynchronous read operation, which could still be pending.</returns>
86 <exception cref="T:System.IO.IOException">The method tried to read asynchronously past the end of the stream, or a disk error occurred.</exception>
87 <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
88 <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
89 <exception cref="T:System.NotSupportedException">The current <see cref="System.IO.Compression.DeflateStream"></see> implementation does not support the read operation.</exception>
90 <exception cref="T:System.InvalidOperationException">This call cannot be completed.</exception>
92 <member name="M:System.IO.Compression.DeflateStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
93 <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>
94 <param name="array"></param>
95 <param name="offset">The byte offset in buffer to begin writing from.</param>
96 <param name="count">The maximum number of bytes to write.</param>
97 <param name="asyncCallback"></param>
98 <param name="asyncState"></param>
99 <returns>An object that represents the asynchronous write operation, which could still be pending.</returns>
100 <exception cref="T:System.IO.IOException">The method tried to write asynchronously past the end of the stream, or a disk error occurred.</exception>
101 <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
102 <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
103 <exception cref="T:System.NotSupportedException">The current <see cref="System.IO.Compression.DeflateStream"></see> implementation does not support the write operation.</exception>
104 <exception cref="T:System.InvalidOperationException">The write operation cannot be performed because the stream is closed.</exception>
106 <member name="P:System.IO.Compression.DeflateStream.CanRead">
107 <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
108 <returns>true if the <see cref="System.IO.Compression.CompressionMode"></see> value is Decompress, and the underlying stream is opened and supports reading; otherwise, false.</returns>
110 <member name="P:System.IO.Compression.DeflateStream.CanSeek">
111 <summary>Gets a value indicating whether the stream supports seeking.</summary>
112 <returns>false in all cases.</returns>
114 <member name="P:System.IO.Compression.DeflateStream.CanWrite">
115 <summary>Gets a value indicating whether the stream supports writing.</summary>
116 <returns>true if the <see cref="System.IO.Compression.CompressionMode"></see> value is Compress, and the underlying stream supports writing and is not closed; otherwise, false.</returns>
118 <member name="M:System.IO.Compression.DeflateStream.Dispose(System.Boolean)">
119 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.DeflateStream"></see> and optionally releases the managed resources.</summary>
120 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
122 <member name="M:System.IO.Compression.DeflateStream.EndRead(System.IAsyncResult)">
123 <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>
124 <param name="asyncResult"></param>
125 <returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <see cref="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>
126 <exception cref="T:System.ArgumentNullException"><paramref name="async_result">async_result</paramref> is null.</exception>
127 <exception cref="T:System.ArgumentException"><paramref name="async_result">async_result</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>
128 <exception cref="T:System.SystemException">An exception was thrown during a call to <see cref="System.Threading.WaitHandle.WaitOne"></see>.</exception>
129 <exception cref="T:System.InvalidOperationException">The stream is null.</exception>
131 <member name="M:System.IO.Compression.DeflateStream.EndWrite(System.IAsyncResult)">
132 <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>
133 <param name="asyncResult"></param>
134 <exception cref="T:System.ArgumentNullException"><paramref name="async_result">async_result</paramref> is null.</exception>
135 <exception cref="T:System.ArgumentException"><paramref name="async_result">async_result</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>
136 <exception cref="T:System.Exception">An exception was thrown during a call to <see cref="System.Threading.WaitHandle.WaitOne"></see>.</exception>
137 <exception cref="T:System.InvalidOperationException">The end write call is invalid.</exception>
139 <member name="M:System.IO.Compression.DeflateStream.Flush">
140 <summary>The current implementation of this method has no functionality.</summary>
141 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
143 <member name="P:System.IO.Compression.DeflateStream.Length">
144 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
145 <returns>A long value.</returns>
146 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
148 <member name="P:System.IO.Compression.DeflateStream.Position">
149 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
150 <returns>A long value.</returns>
151 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
153 <member name="M:System.IO.Compression.DeflateStream.Read(System.Byte[],System.Int32,System.Int32)">
154 <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
155 <param name="array">The array to store decompressed bytes.</param>
156 <param name="offset">The byte offset in array at which the read bytes will be placed.</param>
157 <param name="count">The maximum number of decompressed bytes to read.</param>
158 <returns>The number of bytes that were read into the byte array.</returns>
159 <exception cref="T:System.ArgumentNullException"><paramref name="array">array</paramref> is null.</exception>
160 <exception cref="T:System.InvalidOperationException">The <see cref="System.IO.Compression.CompressionMode"></see> value was Compress when the object was created.
162 The underlying stream does not support reading.</exception>
163 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> or <paramref name="count">count</paramref> is less than zero.
165 <paramref name="array">array</paramref> length minus the index starting point is less than <paramref name="count">count</paramref>.</exception>
166 <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
167 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
169 <member name="M:System.IO.Compression.DeflateStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
170 <param name="array"></param>
171 <param name="offset"></param>
172 <param name="count"></param>
173 <param name="cancellationToken"></param>
176 <member name="M:System.IO.Compression.DeflateStream.Seek(System.Int64,System.IO.SeekOrigin)">
177 <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
178 <param name="offset">The location in the stream.</param>
179 <param name="origin">One of the <see cref="T:System.IO.SeekOrigin"></see> values.</param>
180 <returns>A long value.</returns>
181 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
183 <member name="M:System.IO.Compression.DeflateStream.SetLength(System.Int64)">
184 <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
185 <param name="value">The length of the stream.</param>
186 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
188 <member name="M:System.IO.Compression.DeflateStream.Write(System.Byte[],System.Int32,System.Int32)">
189 <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
190 <param name="array">The buffer that contains the data to compress.</param>
191 <param name="offset">The byte offset in array from which the bytes will be read.</param>
192 <param name="count">The maximum number of bytes to write.</param>
194 <member name="M:System.IO.Compression.DeflateStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
195 <param name="array"></param>
196 <param name="offset"></param>
197 <param name="count"></param>
198 <param name="cancellationToken"></param>
201 <member name="T:System.IO.Compression.GZipStream">
202 <summary>Provides methods and properties used to compress and decompress streams.</summary>
204 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
205 <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>
206 <param name="stream">The stream to write the compressed data to.</param>
207 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
208 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
209 <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 false.)</exception>
211 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
212 <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>
213 <param name="stream">The stream the compressed or decompressed data is written to.</param>
214 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
215 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
216 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> enumeration value.
218 <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 false.
220 <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 false.</exception>
222 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
223 <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>
224 <param name="stream">The stream to write the compressed data to.</param>
225 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
226 <param name="leaveOpen">true to leave the stream object open after disposing the <see cref="T:System.IO.Compression.GZipStream"></see> object; otherwise, false.</param>
227 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
228 <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 false.)</exception>
230 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
231 <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>
232 <param name="stream">The stream the compressed or decompressed data is written to.</param>
233 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
234 <param name="leaveOpen">true to leave the stream open after disposing the <see cref="T:System.IO.Compression.GZipStream"></see> object; otherwise, false.</param>
235 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
236 <exception cref="T:System.ArgumentException"><paramref name="mode">mode</paramref> is not a valid <see cref="System.IO.Compression.CompressionMode"></see> value.
238 <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 false.
240 <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 false.</exception>
242 <member name="P:System.IO.Compression.GZipStream.BaseStream">
243 <summary>Gets a reference to the underlying stream.</summary>
244 <returns>A stream object that represents the underlying stream.</returns>
245 <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
247 <member name="M:System.IO.Compression.GZipStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
248 <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>
249 <param name="array"></param>
250 <param name="offset">The byte offset in array at which to begin reading data from the stream.</param>
251 <param name="count">The maximum number of bytes to read.</param>
252 <param name="asyncCallback"></param>
253 <param name="asyncState"></param>
254 <returns>An object that represents the asynchronous read operation, which could still be pending.</returns>
255 <exception cref="T:System.IO.IOException">The method tried to read asynchronously past the end of the stream, or a disk error occurred.</exception>
256 <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
257 <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
258 <exception cref="T:System.NotSupportedException">The current <see cref="System.IO.Compression.GZipStream"></see> implementation does not support the read operation.</exception>
259 <exception cref="T:System.InvalidOperationException">A read operation cannot be performed because the stream is closed.</exception>
261 <member name="M:System.IO.Compression.GZipStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
262 <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>
263 <param name="array"></param>
264 <param name="offset">The byte offset in array at which to begin writing.</param>
265 <param name="count">The maximum number of bytes to write.</param>
266 <param name="asyncCallback"></param>
267 <param name="asyncState"></param>
268 <returns>An object that represents the asynchronous write operation, which could still be pending.</returns>
269 <exception cref="T:System.InvalidOperationException">The underlying stream is null.
271 The underlying stream is closed.</exception>
273 <member name="P:System.IO.Compression.GZipStream.CanRead">
274 <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
275 <returns>true if the <see cref="System.IO.Compression.CompressionMode"></see> value is Decompress, and the underlying stream supports reading and is not closed; otherwise, false.</returns>
277 <member name="P:System.IO.Compression.GZipStream.CanSeek">
278 <summary>Gets a value indicating whether the stream supports seeking.</summary>
279 <returns>false in all cases.</returns>
281 <member name="P:System.IO.Compression.GZipStream.CanWrite">
282 <summary>Gets a value indicating whether the stream supports writing.</summary>
283 <returns>true if the <see cref="System.IO.Compression.CompressionMode"></see> value is Compress, and the underlying stream supports writing and is not closed; otherwise, false.</returns>
285 <member name="M:System.IO.Compression.GZipStream.Dispose(System.Boolean)">
286 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.GZipStream"></see> and optionally releases the managed resources.</summary>
287 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
289 <member name="M:System.IO.Compression.GZipStream.EndRead(System.IAsyncResult)">
290 <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>
291 <param name="asyncResult"></param>
292 <returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <see cref="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>
293 <exception cref="T:System.ArgumentNullException"><paramref name="async_result">async_result</paramref> is null.</exception>
294 <exception cref="T:System.ArgumentException"><paramref name="async_result">async_result</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>
295 <exception cref="T:System.InvalidOperationException">The end operation cannot be performed because the stream is closed.</exception>
297 <member name="M:System.IO.Compression.GZipStream.EndWrite(System.IAsyncResult)">
298 <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>
299 <param name="asyncResult"></param>
300 <exception cref="T:System.InvalidOperationException">The underlying stream is null.
302 The underlying stream is closed.</exception>
304 <member name="M:System.IO.Compression.GZipStream.Flush">
305 <summary>The current implementation of this method has no functionality.</summary>
306 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
308 <member name="P:System.IO.Compression.GZipStream.Length">
309 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
310 <returns>A long value.</returns>
311 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
313 <member name="P:System.IO.Compression.GZipStream.Position">
314 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
315 <returns>A long value.</returns>
316 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
318 <member name="M:System.IO.Compression.GZipStream.Read(System.Byte[],System.Int32,System.Int32)">
319 <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
320 <param name="array">The array used to store decompressed bytes.</param>
321 <param name="offset">The byte offset in array at which the read bytes will be placed.</param>
322 <param name="count">The maximum number of decompressed bytes to read.</param>
323 <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>
324 <exception cref="T:System.ArgumentNullException"><paramref name="array">array</paramref> is null.</exception>
325 <exception cref="T:System.InvalidOperationException">The <see cref="System.IO.Compression.CompressionMode"></see> value was Compress when the object was created.
327 The underlying stream does not support reading.</exception>
328 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> or <paramref name="count">count</paramref> is less than zero.
330 <paramref name="array">array</paramref> length minus the index starting point is less than <paramref name="count">count</paramref>.</exception>
331 <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
332 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
334 <member name="M:System.IO.Compression.GZipStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
335 <param name="array"></param>
336 <param name="offset"></param>
337 <param name="count"></param>
338 <param name="cancellationToken"></param>
341 <member name="M:System.IO.Compression.GZipStream.Seek(System.Int64,System.IO.SeekOrigin)">
342 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
343 <param name="offset">The location in the stream.</param>
344 <param name="origin">One of the <see cref="T:System.IO.SeekOrigin"></see> values.</param>
345 <returns>A long value.</returns>
346 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
348 <member name="M:System.IO.Compression.GZipStream.SetLength(System.Int64)">
349 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException"></see>.</summary>
350 <param name="value">The length of the stream.</param>
351 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
353 <member name="M:System.IO.Compression.GZipStream.Write(System.Byte[],System.Int32,System.Int32)">
354 <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
355 <param name="array">The buffer that contains the data to compress.</param>
356 <param name="offset">The byte offset in array from which the bytes will be read.</param>
357 <param name="count">The maximum number of bytes to write.</param>
358 <exception cref="T:System.ObjectDisposedException">The write operation cannot be performed because the stream is closed.</exception>
360 <member name="M:System.IO.Compression.GZipStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
361 <param name="array"></param>
362 <param name="offset"></param>
363 <param name="count"></param>
364 <param name="cancellationToken"></param>
367 <member name="T:System.IO.Compression.ZipArchive">
368 <summary>Represents a package of compressed files in the zip archive format.</summary>
370 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream)">
371 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class from the specified stream.</summary>
372 <param name="stream">The stream that contains the archive to be read.</param>
373 <exception cref="T:System.ArgumentException">The stream is already closed or does not support reading.</exception>
374 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
375 <exception cref="T:System.IO.InvalidDataException">The contents of the stream are not in the zip archive format.</exception>
377 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode)">
378 <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>
379 <param name="stream">The input or output stream.</param>
380 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
381 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
382 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
383 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode">mode</paramref> is an invalid value.</exception>
384 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.
386 <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.
388 <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>
390 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean)">
391 <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>
392 <param name="stream">The input or output stream.</param>
393 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
394 <param name="leaveOpen">true to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive"></see> object is disposed; otherwise, false.</param>
395 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
396 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
397 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode">mode</paramref> is an invalid value.</exception>
398 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.
400 <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.
402 <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>
404 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean,System.Text.Encoding)">
405 <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>
406 <param name="stream">The input or output stream.</param>
407 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
408 <param name="leaveOpen">true to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive"></see> object is disposed; otherwise, false.</param>
409 <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>
410 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
411 <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
412 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode">mode</paramref> is an invalid value.</exception>
413 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.
415 <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.
417 <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>
419 <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String)">
420 <summary>Creates an empty entry that has the specified path and entry name in the zip archive.</summary>
421 <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
422 <returns>An empty entry in the zip archive.</returns>
423 <exception cref="T:System.ArgumentException"><paramref name="entryName">entryName</paramref> is <see cref="System.String.Empty"></see>.</exception>
424 <exception cref="T:System.ArgumentNullException"><paramref name="entryName">entryName</paramref> is null.</exception>
425 <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
426 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
428 <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String,System.IO.Compression.CompressionLevel)">
429 <summary>Creates an empty entry that has the specified entry name and compression level in the zip archive.</summary>
430 <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
431 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
432 <returns>An empty entry in the zip archive.</returns>
433 <exception cref="T:System.ArgumentException"><paramref name="entryName">entryName</paramref> is <see cref="System.String.Empty"></see>.</exception>
434 <exception cref="T:System.ArgumentNullException"><paramref name="entryName">entryName</paramref> is null.</exception>
435 <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
436 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
438 <member name="M:System.IO.Compression.ZipArchive.Dispose">
439 <summary>Releases the resources used by the current instance of the <see cref="T:System.IO.Compression.ZipArchive"></see> class.</summary>
441 <member name="M:System.IO.Compression.ZipArchive.Dispose(System.Boolean)">
442 <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>
443 <param name="disposing">true to finish writing the archive and release unmanaged and managed resources; false to release only unmanaged resources.</param>
445 <member name="P:System.IO.Compression.ZipArchive.Entries">
446 <summary>Gets the collection of entries that are currently in the zip archive.</summary>
447 <returns>The collection of entries that are currently in the zip archive.</returns>
448 <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
449 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
450 <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
452 <member name="M:System.IO.Compression.ZipArchive.GetEntry(System.String)">
453 <summary>Retrieves a wrapper for the specified entry in the zip archive.</summary>
454 <param name="entryName">A path, relative to the root of the archive, that identifies the entry to retrieve.</param>
455 <returns>A wrapper for the specified entry in the archive; null if the entry does not exist in the archive.</returns>
456 <exception cref="T:System.ArgumentException"><paramref name="entryName">entryName</paramref> is <see cref="System.String.Empty"></see>.</exception>
457 <exception cref="T:System.ArgumentNullException"><paramref name="entryName">entryName</paramref> is null.</exception>
458 <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
459 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
460 <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
462 <member name="P:System.IO.Compression.ZipArchive.Mode">
463 <summary>Gets a value that describes the type of action the zip archive can perform on entries.</summary>
464 <returns>One of the enumeration values that describes the type of action (read, create, or update) the zip archive can perform on entries.</returns>
466 <member name="T:System.IO.Compression.ZipArchiveEntry">
467 <summary>Represents a compressed file within a zip archive.</summary>
469 <member name="P:System.IO.Compression.ZipArchiveEntry.Archive">
470 <summary>Gets the zip archive that the entry belongs to.</summary>
471 <returns>The zip archive that the entry belongs to, or null if the entry has been deleted.</returns>
473 <member name="P:System.IO.Compression.ZipArchiveEntry.CompressedLength">
474 <summary>Gets the compressed size of the entry in the zip archive.</summary>
475 <returns>The compressed size of the entry in the zip archive.</returns>
476 <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
478 <member name="M:System.IO.Compression.ZipArchiveEntry.Delete">
479 <summary>Deletes the entry from the zip archive.</summary>
480 <exception cref="T:System.IO.IOException">The entry is already open for reading or writing.</exception>
481 <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>
482 <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
484 <member name="P:System.IO.Compression.ZipArchiveEntry.ExternalAttributes">
487 <member name="P:System.IO.Compression.ZipArchiveEntry.FullName">
488 <summary>Gets the relative path of the entry in the zip archive.</summary>
489 <returns>The relative path of the entry in the zip archive.</returns>
491 <member name="P:System.IO.Compression.ZipArchiveEntry.LastWriteTime">
492 <summary>Gets or sets the last time the entry in the zip archive was changed.</summary>
493 <returns>The last time the entry in the zip archive was changed.</returns>
494 <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>
495 <exception cref="T:System.IO.IOException">The archive mode is set to <see cref="System.IO.Compression.ZipArchiveMode.Create"></see>.
497 The archive mode is set to <see cref="System.IO.Compression.ZipArchiveMode.Update"></see> and the entry has been opened.</exception>
498 <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>
500 <member name="P:System.IO.Compression.ZipArchiveEntry.Length">
501 <summary>Gets the uncompressed size of the entry in the zip archive.</summary>
502 <returns>The uncompressed size of the entry in the zip archive.</returns>
503 <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
505 <member name="P:System.IO.Compression.ZipArchiveEntry.Name">
506 <summary>Gets the file name of the entry in the zip archive.</summary>
507 <returns>The file name of the entry in the zip archive.</returns>
509 <member name="M:System.IO.Compression.ZipArchiveEntry.Open">
510 <summary>Opens the entry from the zip archive.</summary>
511 <returns>The stream that represents the contents of the entry.</returns>
512 <exception cref="T:System.IO.IOException">The entry is already currently open for writing.
514 The entry has been deleted from the archive.
516 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>
517 <exception cref="T:System.IO.InvalidDataException">The entry is either missing from the archive or is corrupt and cannot be read.
519 The entry has been compressed by using a compression method that is not supported.</exception>
520 <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
522 <member name="M:System.IO.Compression.ZipArchiveEntry.ToString">
523 <summary>Retrieves the relative path of the entry in the zip archive.</summary>
524 <returns>The relative path of the entry, which is the value stored in the <see cref="System.IO.Compression.ZipArchiveEntry.FullName"></see> property.</returns>
526 <member name="T:System.IO.Compression.ZipArchiveMode">
527 <summary>Specifies values for interacting with zip archive entries.</summary>
529 <member name="F:System.IO.Compression.ZipArchiveMode.Create">
530 <summary>Only creating new archive entries is permitted.</summary>
533 <member name="F:System.IO.Compression.ZipArchiveMode.Read">
534 <summary>Only reading archive entries is permitted.</summary>
537 <member name="F:System.IO.Compression.ZipArchiveMode.Update">
538 <summary>Both read and write operations are permitted for archive entries.</summary>