1 <?xml version="1.0" encoding="utf-8"?>
\r
4 <name>System.IO.Compression</name>
\r
7 <member name="T:System.IO.Compression.CompressionLevel">
\r
8 <summary>Specifies values that indicate whether a compression operation emphasizes speed or compression size.</summary>
\r
10 <member name="F:System.IO.Compression.CompressionLevel.Fastest">
\r
11 <summary>The compression operation should complete as quickly as possible, even if the resulting file is not optimally compressed.</summary>
\r
13 <member name="F:System.IO.Compression.CompressionLevel.NoCompression">
\r
14 <summary>No compression should be performed on the file.</summary>
\r
16 <member name="F:System.IO.Compression.CompressionLevel.Optimal">
\r
17 <summary>The compression operation should be optimally compressed, even if the operation takes a longer time to complete.</summary>
\r
19 <member name="T:System.IO.Compression.CompressionMode">
\r
20 <summary> Specifies whether to compress or decompress the underlying stream.</summary>
\r
22 <member name="F:System.IO.Compression.CompressionMode.Compress">
\r
23 <summary>Compresses the underlying stream.</summary>
\r
25 <member name="F:System.IO.Compression.CompressionMode.Decompress">
\r
26 <summary>Decompresses the underlying stream.</summary>
\r
28 <member name="T:System.IO.Compression.DeflateStream">
\r
29 <summary>Provides methods and properties for compressing and decompressing streams by using the Deflate algorithm.</summary>
\r
31 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
\r
32 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream" /> class by using the specified stream and compression level.</summary>
\r
33 <param name="stream">The stream to compress.</param>
\r
34 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
\r
35 <exception cref="T:System.ArgumentNullException">
\r
36 <paramref name="stream" /> is null.</exception>
\r
37 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="P:System.IO.Stream.CanWrite" /> property on the stream object is false.)</exception>
\r
39 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
\r
40 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream" /> class by using the specified stream and compression level, and optionally leaves the stream open.</summary>
\r
41 <param name="stream">The stream to compress.</param>
\r
42 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
\r
43 <param name="leaveOpen">true to leave the stream object open after disposing the <see cref="T:System.IO.Compression.DeflateStream" /> object; otherwise, false.</param>
\r
44 <exception cref="T:System.ArgumentNullException">
\r
45 <paramref name="stream" /> is null.</exception>
\r
46 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="P:System.IO.Stream.CanWrite" /> property on the stream object is false.)</exception>
\r
48 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
\r
49 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream" /> class by using the specified stream and compression mode.</summary>
\r
50 <param name="stream">The stream to compress or decompress.</param>
\r
51 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
\r
52 <exception cref="T:System.ArgumentNullException">
\r
53 <paramref name="stream" /> is null.</exception>
\r
54 <exception cref="T:System.ArgumentException">
\r
55 <paramref name="mode" /> is not a valid <see cref="T:System.IO.Compression.CompressionMode" /> value.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Compress" /> and <see cref="P:System.IO.Stream.CanWrite" /> is false.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Decompress" /> and <see cref="P:System.IO.Stream.CanRead" /> is false.</exception>
\r
57 <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
\r
58 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream" /> class by using the specified stream and compression mode, and optionally leaves the stream open.</summary>
\r
59 <param name="stream">The stream to compress or decompress.</param>
\r
60 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
\r
61 <param name="leaveOpen">true to leave the stream open after disposing the <see cref="T:System.IO.Compression.DeflateStream" /> object; otherwise, false.</param>
\r
62 <exception cref="T:System.ArgumentNullException">
\r
63 <paramref name="stream" /> is null.</exception>
\r
64 <exception cref="T:System.ArgumentException">
\r
65 <paramref name="mode" /> is not a valid <see cref="T:System.IO.Compression.CompressionMode" /> value.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Compress" /> and <see cref="P:System.IO.Stream.CanWrite" /> is false.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Decompress" /> and <see cref="P:System.IO.Stream.CanRead" /> is false.</exception>
\r
67 <member name="P:System.IO.Compression.DeflateStream.BaseStream">
\r
68 <summary>Gets a reference to the underlying stream.</summary>
\r
69 <returns>A stream object that represents the underlying stream.</returns>
\r
70 <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
\r
72 <member name="P:System.IO.Compression.DeflateStream.CanRead">
\r
73 <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
\r
74 <returns>true if the <see cref="T:System.IO.Compression.CompressionMode" /> value is Decompress, and the underlying stream is opened and supports reading; otherwise, false.</returns>
\r
76 <member name="P:System.IO.Compression.DeflateStream.CanSeek">
\r
77 <summary>Gets a value indicating whether the stream supports seeking.</summary>
\r
78 <returns>false in all cases.</returns>
\r
80 <member name="P:System.IO.Compression.DeflateStream.CanWrite">
\r
81 <summary>Gets a value indicating whether the stream supports writing.</summary>
\r
82 <returns>true if the <see cref="T:System.IO.Compression.CompressionMode" /> value is Compress, and the underlying stream supports writing and is not closed; otherwise, false.</returns>
\r
84 <member name="M:System.IO.Compression.DeflateStream.Dispose(System.Boolean)">
\r
85 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.DeflateStream" /> and optionally releases the managed resources.</summary>
\r
86 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
\r
88 <member name="M:System.IO.Compression.DeflateStream.Flush">
\r
89 <summary>The current implementation of this method has no functionality.</summary>
\r
90 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
\r
92 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
95 <member name="P:System.IO.Compression.DeflateStream.Length">
\r
96 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
97 <returns>A long value.</returns>
\r
98 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
100 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
103 <member name="P:System.IO.Compression.DeflateStream.Position">
\r
104 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
105 <returns>A long value.</returns>
\r
106 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
108 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
111 <member name="M:System.IO.Compression.DeflateStream.Read(System.Byte[],System.Int32,System.Int32)">
\r
112 <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
\r
113 <returns>The number of bytes that were read into the byte array.</returns>
\r
114 <param name="array">The array to store decompressed bytes.</param>
\r
115 <param name="offset">The byte offset in <paramref name="array" /> at which the read bytes will be placed.</param>
\r
116 <param name="count">The maximum number of decompressed bytes to read.</param>
\r
117 <exception cref="T:System.ArgumentNullException">
\r
118 <paramref name="array" /> is null.</exception>
\r
119 <exception cref="T:System.InvalidOperationException">The <see cref="T:System.IO.Compression.CompressionMode" /> value was Compress when the object was created.- or - The underlying stream does not support reading.</exception>
\r
120 <exception cref="T:System.ArgumentOutOfRangeException">
\r
121 <paramref name="offset" /> or <paramref name="count" /> is less than zero.-or-<paramref name="array" /> length minus the index starting point is less than <paramref name="count" />.</exception>
\r
122 <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
\r
123 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
\r
125 <member name="M:System.IO.Compression.DeflateStream.Seek(System.Int64,System.IO.SeekOrigin)">
\r
126 <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
127 <returns>A long value.</returns>
\r
128 <param name="offset">The location in the stream.</param>
\r
129 <param name="origin">One of the <see cref="T:System.IO.SeekOrigin" /> values.</param>
\r
130 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
132 <member name="M:System.IO.Compression.DeflateStream.SetLength(System.Int64)">
\r
133 <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
134 <param name="value">The length of the stream.</param>
\r
135 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
137 <member name="M:System.IO.Compression.DeflateStream.Write(System.Byte[],System.Int32,System.Int32)">
\r
138 <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
\r
139 <param name="array">The buffer that contains the data to compress.</param>
\r
140 <param name="offset">The byte offset in <paramref name="array" /> from which the bytes will be read.</param>
\r
141 <param name="count">The maximum number of bytes to write.</param>
\r
143 <member name="T:System.IO.Compression.GZipStream">
\r
144 <summary>Provides methods and properties used to compress and decompress streams.</summary>
\r
146 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
\r
147 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream" /> class by using the specified stream and compression level.</summary>
\r
148 <param name="stream">The stream to write the compressed data to.</param>
\r
149 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
\r
150 <exception cref="T:System.ArgumentNullException">
\r
151 <paramref name="stream" /> is null.</exception>
\r
152 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="P:System.IO.Stream.CanWrite" /> property on the stream object is false.)</exception>
\r
154 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
\r
155 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream" /> class by using the specified stream and compression level, and optionally leaves the stream open.</summary>
\r
156 <param name="stream">The stream to write the compressed data to.</param>
\r
157 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
\r
158 <param name="leaveOpen">true to leave the stream object open after disposing the <see cref="T:System.IO.Compression.GZipStream" /> object; otherwise, false.</param>
\r
159 <exception cref="T:System.ArgumentNullException">
\r
160 <paramref name="stream" /> is null.</exception>
\r
161 <exception cref="T:System.ArgumentException">The stream does not support write operations such as compression. (The <see cref="P:System.IO.Stream.CanWrite" /> property on the stream object is false.)</exception>
\r
163 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
\r
164 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream" /> class by using the specified stream and compression mode.</summary>
\r
165 <param name="stream">The stream the compressed or decompressed data is written to.</param>
\r
166 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
\r
167 <exception cref="T:System.ArgumentNullException">
\r
168 <paramref name="stream" /> is null.</exception>
\r
169 <exception cref="T:System.ArgumentException">
\r
170 <paramref name="mode" /> is not a valid <see cref="T:System.IO.Compression.CompressionMode" /> enumeration value.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Compress" /> and <see cref="P:System.IO.Stream.CanWrite" /> is false.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Decompress" /> and <see cref="P:System.IO.Stream.CanRead" /> is false.</exception>
\r
172 <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
\r
173 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream" /> class by using the specified stream and compression mode, and optionally leaves the stream open.</summary>
\r
174 <param name="stream">The stream the compressed or decompressed data is written to.</param>
\r
175 <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
\r
176 <param name="leaveOpen">true to leave the stream open after disposing the <see cref="T:System.IO.Compression.GZipStream" /> object; otherwise, false.</param>
\r
177 <exception cref="T:System.ArgumentNullException">
\r
178 <paramref name="stream" /> is null.</exception>
\r
179 <exception cref="T:System.ArgumentException">
\r
180 <paramref name="mode" /> is not a valid <see cref="T:System.IO.Compression.CompressionMode" /> value.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Compress" /> and <see cref="P:System.IO.Stream.CanWrite" /> is false.-or-<see cref="T:System.IO.Compression.CompressionMode" /> is <see cref="F:System.IO.Compression.CompressionMode.Decompress" /> and <see cref="P:System.IO.Stream.CanRead" /> is false.</exception>
\r
182 <member name="P:System.IO.Compression.GZipStream.BaseStream">
\r
183 <summary>Gets a reference to the underlying stream.</summary>
\r
184 <returns>A stream object that represents the underlying stream.</returns>
\r
185 <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
\r
187 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
190 <member name="P:System.IO.Compression.GZipStream.CanRead">
\r
191 <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
\r
192 <returns>true if the <see cref="T:System.IO.Compression.CompressionMode" /> value is Decompress, and the underlying stream supports reading and is not closed; otherwise, false.</returns>
\r
194 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
197 <member name="P:System.IO.Compression.GZipStream.CanSeek">
\r
198 <summary>Gets a value indicating whether the stream supports seeking.</summary>
\r
199 <returns>false in all cases.</returns>
\r
201 <member name="P:System.IO.Compression.GZipStream.CanWrite">
\r
202 <summary>Gets a value indicating whether the stream supports writing.</summary>
\r
203 <returns>true if the <see cref="T:System.IO.Compression.CompressionMode" /> value is Compress, and the underlying stream supports writing and is not closed; otherwise, false.</returns>
\r
205 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
208 <member name="M:System.IO.Compression.GZipStream.Dispose(System.Boolean)">
\r
209 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.GZipStream" /> and optionally releases the managed resources.</summary>
\r
210 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
\r
212 <member name="M:System.IO.Compression.GZipStream.Flush">
\r
213 <summary>The current implementation of this method has no functionality.</summary>
\r
214 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
\r
216 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
219 <member name="P:System.IO.Compression.GZipStream.Length">
\r
220 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
221 <returns>A long value.</returns>
\r
222 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
224 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
227 <member name="P:System.IO.Compression.GZipStream.Position">
\r
228 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
229 <returns>A long value.</returns>
\r
230 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
232 <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
\r
235 <member name="M:System.IO.Compression.GZipStream.Read(System.Byte[],System.Int32,System.Int32)">
\r
236 <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
\r
237 <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>
\r
238 <param name="array">The array used to store decompressed bytes.</param>
\r
239 <param name="offset">The byte offset in <paramref name="array" /> at which the read bytes will be placed.</param>
\r
240 <param name="count">The maximum number of decompressed bytes to read.</param>
\r
241 <exception cref="T:System.ArgumentNullException">
\r
242 <paramref name="array" /> is null.</exception>
\r
243 <exception cref="T:System.InvalidOperationException">The <see cref="T:System.IO.Compression.CompressionMode" /> value was Compress when the object was created.- or -The underlying stream does not support reading.</exception>
\r
244 <exception cref="T:System.ArgumentOutOfRangeException">
\r
245 <paramref name="offset" /> or <paramref name="count" /> is less than zero.-or-<paramref name="array" /> length minus the index starting point is less than <paramref name="count" />.</exception>
\r
246 <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
\r
247 <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
\r
249 <member name="M:System.IO.Compression.GZipStream.Seek(System.Int64,System.IO.SeekOrigin)">
\r
250 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
251 <returns>A long value.</returns>
\r
252 <param name="offset">The location in the stream.</param>
\r
253 <param name="origin">One of the <see cref="T:System.IO.SeekOrigin" /> values.</param>
\r
254 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
256 <member name="M:System.IO.Compression.GZipStream.SetLength(System.Int64)">
\r
257 <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
\r
258 <param name="value">The length of the stream.</param>
\r
259 <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
\r
261 <member name="M:System.IO.Compression.GZipStream.Write(System.Byte[],System.Int32,System.Int32)">
\r
262 <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
\r
263 <param name="array">The buffer that contains the data to compress.</param>
\r
264 <param name="offset">The byte offset in <paramref name="array" /> from which the bytes will be read.</param>
\r
265 <param name="count">The maximum number of bytes to write.</param>
\r
266 <exception cref="T:System.ObjectDisposedException">The write operation cannot be performed because the stream is closed.</exception>
\r
268 <member name="T:System.IO.Compression.ZipArchive">
\r
269 <summary>Represents a package of compressed files in the zip archive format.</summary>
\r
271 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream)">
\r
272 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class from the specified stream.</summary>
\r
273 <param name="stream">The stream that contains the archive to be read.</param>
\r
274 <exception cref="T:System.ArgumentException">The stream is already closed or does not support reading.</exception>
\r
275 <exception cref="T:System.ArgumentNullException">
\r
276 <paramref name="stream" /> is null.</exception>
\r
277 <exception cref="T:System.IO.InvalidDataException">The contents of the stream are not in the zip archive format.</exception>
\r
279 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode)">
\r
280 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class from the specified stream and with the specified mode.</summary>
\r
281 <param name="stream">The input or output stream.</param>
\r
282 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
\r
283 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
\r
284 <exception cref="T:System.ArgumentNullException">
\r
285 <paramref name="stream" /> is null.</exception>
\r
286 <exception cref="T:System.ArgumentOutOfRangeException">
\r
287 <paramref name="mode" /> is an invalid value.</exception>
\r
288 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.-or-<paramref name="mode" /> is <see cref="F:System.IO.Compression.ZipArchiveMode.Update" /> and an entry is missing from the archive or is corrupt and cannot be read.-or-<paramref name="mode" /> is <see cref="F:System.IO.Compression.ZipArchiveMode.Update" /> and an entry is too large to fit into memory.</exception>
\r
290 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean)">
\r
291 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class on the specified stream for the specified mode, and optionally leaves the stream open.</summary>
\r
292 <param name="stream">The input or output stream.</param>
\r
293 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
\r
294 <param name="leaveOpen">true to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive" /> object is disposed; otherwise, false.</param>
\r
295 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
\r
296 <exception cref="T:System.ArgumentNullException">
\r
297 <paramref name="stream" /> is null.</exception>
\r
298 <exception cref="T:System.ArgumentOutOfRangeException">
\r
299 <paramref name="mode" /> is an invalid value.</exception>
\r
300 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.-or-<paramref name="mode" /> is <see cref="F:System.IO.Compression.ZipArchiveMode.Update" /> and an entry is missing from the archive or is corrupt and cannot be read.-or-<paramref name="mode" /> is <see cref="F:System.IO.Compression.ZipArchiveMode.Update" /> and an entry is too large to fit into memory.</exception>
\r
302 <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean,System.Text.Encoding)">
\r
303 <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class on the specified stream for the specified mode, uses the specified encoding for entry names, and optionally leaves the stream open.</summary>
\r
304 <param name="stream">The input or output stream.</param>
\r
305 <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
\r
306 <param name="leaveOpen">true to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive" /> object is disposed; otherwise, false.</param>
\r
307 <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>
\r
308 <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
\r
309 <exception cref="T:System.ArgumentNullException">
\r
310 <paramref name="stream" /> is null.</exception>
\r
311 <exception cref="T:System.ArgumentOutOfRangeException">
\r
312 <paramref name="mode" /> is an invalid value.</exception>
\r
313 <exception cref="T:System.IO.InvalidDataException">The contents of the stream could not be interpreted as a zip archive.-or-<paramref name="mode" /> is <see cref="F:System.IO.Compression.ZipArchiveMode.Update" /> and an entry is missing from the archive or is corrupt and cannot be read.-or-<paramref name="mode" /> is <see cref="F:System.IO.Compression.ZipArchiveMode.Update" /> and an entry is too large to fit into memory.</exception>
\r
315 <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String)">
\r
316 <summary>Creates an empty entry that has the specified path and entry name in the zip archive.</summary>
\r
317 <returns>An empty entry in the zip archive.</returns>
\r
318 <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
\r
319 <exception cref="T:System.ArgumentException">
\r
320 <paramref name="entryName" /> is <see cref="F:System.String.Empty" />.</exception>
\r
321 <exception cref="T:System.ArgumentNullException">
\r
322 <paramref name="entryName" /> is null.</exception>
\r
323 <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
\r
324 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
\r
326 <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String,System.IO.Compression.CompressionLevel)">
\r
327 <summary>Creates an empty entry that has the specified entry name and compression level in the zip archive.</summary>
\r
328 <returns>An empty entry in the zip archive.</returns>
\r
329 <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
\r
330 <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
\r
331 <exception cref="T:System.ArgumentException">
\r
332 <paramref name="entryName" /> is <see cref="F:System.String.Empty" />.</exception>
\r
333 <exception cref="T:System.ArgumentNullException">
\r
334 <paramref name="entryName" /> is null.</exception>
\r
335 <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
\r
336 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
\r
338 <member name="M:System.IO.Compression.ZipArchive.Dispose">
\r
339 <summary>Releases the resources used by the current instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class.</summary>
\r
341 <member name="M:System.IO.Compression.ZipArchive.Dispose(System.Boolean)">
\r
342 <summary>Called by the <see cref="M:System.IO.Compression.ZipArchive.Dispose" /> and <see cref="M:System.Object.Finalize" /> methods to release the unmanaged resources used by the current instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class, and optionally finishes writing the archive and releases the managed resources.</summary>
\r
343 <param name="disposing">true to finish writing the archive and release unmanaged and managed resources; false to release only unmanaged resources.</param>
\r
345 <member name="P:System.IO.Compression.ZipArchive.Entries">
\r
346 <summary>Gets the collection of entries that are currently in the zip archive.</summary>
\r
347 <returns>The collection of entries that are currently in the zip archive.</returns>
\r
348 <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
\r
349 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
\r
350 <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
\r
352 <member name="M:System.IO.Compression.ZipArchive.GetEntry(System.String)">
\r
353 <summary>Retrieves a wrapper for the specified entry in the zip archive.</summary>
\r
354 <returns>A wrapper for the specified entry in the archive; null if the entry does not exist in the archive.</returns>
\r
355 <param name="entryName">A path, relative to the root of the archive, that identifies the entry to retrieve.</param>
\r
356 <exception cref="T:System.ArgumentException">
\r
357 <paramref name="entryName" /> is <see cref="F:System.String.Empty" />.</exception>
\r
358 <exception cref="T:System.ArgumentNullException">
\r
359 <paramref name="entryName" /> is null.</exception>
\r
360 <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
\r
361 <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
\r
362 <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
\r
364 <member name="P:System.IO.Compression.ZipArchive.Mode">
\r
365 <summary>Gets a value that describes the type of action the zip archive can perform on entries.</summary>
\r
366 <returns>One of the enumeration values that describes the type of action (read, create, or update) the zip archive can perform on entries.</returns>
\r
368 <member name="T:System.IO.Compression.ZipArchiveEntry">
\r
369 <summary>Represents a compressed file within a zip archive.</summary>
\r
371 <member name="P:System.IO.Compression.ZipArchiveEntry.Archive">
\r
372 <summary>Gets the zip archive that the entry belongs to.</summary>
\r
373 <returns>The zip archive that the entry belongs to, or null if the entry has been deleted.</returns>
\r
375 <member name="P:System.IO.Compression.ZipArchiveEntry.CompressedLength">
\r
376 <summary>Gets the compressed size of the entry in the zip archive.</summary>
\r
377 <returns>The compressed size of the entry in the zip archive.</returns>
\r
378 <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
\r
380 <member name="M:System.IO.Compression.ZipArchiveEntry.Delete">
\r
381 <summary>Deletes the entry from the zip archive.</summary>
\r
382 <exception cref="T:System.IO.IOException">The entry is already open for reading or writing.</exception>
\r
383 <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" />. </exception>
\r
384 <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
\r
386 <member name="P:System.IO.Compression.ZipArchiveEntry.FullName">
\r
387 <summary>Gets the relative path of the entry in the zip archive.</summary>
\r
388 <returns>The relative path of the entry in the zip archive.</returns>
\r
390 <member name="P:System.IO.Compression.ZipArchiveEntry.LastWriteTime">
\r
391 <summary>Gets or sets the last time the entry in the zip archive was changed.</summary>
\r
392 <returns>The last time the entry in the zip archive was changed.</returns>
\r
393 <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" /> mode.</exception>
\r
394 <exception cref="T:System.IO.IOException">The archive mode is set to <see cref="F:System.IO.Compression.ZipArchiveMode.Create" />.- or -The archive mode is set to <see cref="F:System.IO.Compression.ZipArchiveMode.Update" /> and the entry has been opened.</exception>
\r
395 <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>
\r
397 <member name="P:System.IO.Compression.ZipArchiveEntry.Length">
\r
398 <summary>Gets the uncompressed size of the entry in the zip archive.</summary>
\r
399 <returns>The uncompressed size of the entry in the zip archive.</returns>
\r
400 <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
\r
402 <member name="P:System.IO.Compression.ZipArchiveEntry.Name">
\r
403 <summary>Gets the file name of the entry in the zip archive.</summary>
\r
404 <returns>The file name of the entry in the zip archive.</returns>
\r
406 <member name="M:System.IO.Compression.ZipArchiveEntry.Open">
\r
407 <summary>Opens the entry from the zip archive.</summary>
\r
408 <returns>The stream that represents the contents of the entry.</returns>
\r
409 <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" /> mode, and this entry has already been written to. </exception>
\r
410 <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>
\r
411 <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
\r
413 <member name="M:System.IO.Compression.ZipArchiveEntry.ToString">
\r
414 <summary>Retrieves the relative path of the entry in the zip archive.</summary>
\r
415 <returns>The relative path of the entry, which is the value stored in the <see cref="P:System.IO.Compression.ZipArchiveEntry.FullName" /> property.</returns>
\r
417 <member name="T:System.IO.Compression.ZipArchiveMode">
\r
418 <summary>Specifies values for interacting with zip archive entries.</summary>
\r
420 <member name="F:System.IO.Compression.ZipArchiveMode.Create">
\r
421 <summary>Only creating new archive entries is permitted.</summary>
\r
423 <member name="F:System.IO.Compression.ZipArchiveMode.Read">
\r
424 <summary>Only reading archive entries is permitted.</summary>
\r
426 <member name="F:System.IO.Compression.ZipArchiveMode.Update">
\r
427 <summary>Both read and write operations are permitted for archive entries.</summary>
\r