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