System.IO.Compression.xml 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. <?xml version="1.0" encoding="utf-8"?>
  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. </member>
  13. <member name="F:System.IO.Compression.CompressionLevel.NoCompression">
  14. <summary>No compression should be performed on the file.</summary>
  15. </member>
  16. <member name="F:System.IO.Compression.CompressionLevel.Optimal">
  17. <summary>The compression operation should be optimally compressed, even if the operation takes a longer time to complete.</summary>
  18. </member>
  19. <member name="T:System.IO.Compression.CompressionMode">
  20. <summary> Specifies whether to compress or decompress the underlying stream.</summary>
  21. </member>
  22. <member name="F:System.IO.Compression.CompressionMode.Compress">
  23. <summary>Compresses the underlying stream.</summary>
  24. </member>
  25. <member name="F:System.IO.Compression.CompressionMode.Decompress">
  26. <summary>Decompresses the underlying stream.</summary>
  27. </member>
  28. <member name="T:System.IO.Compression.DeflateStream">
  29. <summary>Provides methods and properties for compressing and decompressing streams by using the Deflate algorithm.</summary>
  30. </member>
  31. <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
  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>
  33. <param name="stream">The stream to compress.</param>
  34. <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
  35. <exception cref="T:System.ArgumentNullException">
  36. <paramref name="stream" /> is null.</exception>
  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>
  38. </member>
  39. <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
  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>
  41. <param name="stream">The stream to compress.</param>
  42. <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
  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>
  44. <exception cref="T:System.ArgumentNullException">
  45. <paramref name="stream" /> is null.</exception>
  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>
  47. </member>
  48. <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
  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>
  50. <param name="stream">The stream to compress or decompress.</param>
  51. <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
  52. <exception cref="T:System.ArgumentNullException">
  53. <paramref name="stream" /> is null.</exception>
  54. <exception cref="T:System.ArgumentException">
  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>
  56. </member>
  57. <member name="M:System.IO.Compression.DeflateStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
  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>
  59. <param name="stream">The stream to compress or decompress.</param>
  60. <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
  61. <param name="leaveOpen">true to leave the stream open after disposing the <see cref="T:System.IO.Compression.DeflateStream" /> object; otherwise, false.</param>
  62. <exception cref="T:System.ArgumentNullException">
  63. <paramref name="stream" /> is null.</exception>
  64. <exception cref="T:System.ArgumentException">
  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>
  66. </member>
  67. <member name="P:System.IO.Compression.DeflateStream.BaseStream">
  68. <summary>Gets a reference to the underlying stream.</summary>
  69. <returns>A stream object that represents the underlying stream.</returns>
  70. <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
  71. </member>
  72. <member name="P:System.IO.Compression.DeflateStream.CanRead">
  73. <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
  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>
  75. </member>
  76. <member name="P:System.IO.Compression.DeflateStream.CanSeek">
  77. <summary>Gets a value indicating whether the stream supports seeking.</summary>
  78. <returns>false in all cases.</returns>
  79. </member>
  80. <member name="P:System.IO.Compression.DeflateStream.CanWrite">
  81. <summary>Gets a value indicating whether the stream supports writing.</summary>
  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>
  83. </member>
  84. <member name="M:System.IO.Compression.DeflateStream.Dispose(System.Boolean)">
  85. <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.DeflateStream" /> and optionally releases the managed resources.</summary>
  86. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  87. </member>
  88. <member name="M:System.IO.Compression.DeflateStream.Flush">
  89. <summary>The current implementation of this method has no functionality.</summary>
  90. <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
  91. <PermissionSet>
  92. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  93. </PermissionSet>
  94. </member>
  95. <member name="P:System.IO.Compression.DeflateStream.Length">
  96. <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  97. <returns>A long value.</returns>
  98. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  99. <PermissionSet>
  100. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  101. </PermissionSet>
  102. </member>
  103. <member name="P:System.IO.Compression.DeflateStream.Position">
  104. <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  105. <returns>A long value.</returns>
  106. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  107. <PermissionSet>
  108. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  109. </PermissionSet>
  110. </member>
  111. <member name="M:System.IO.Compression.DeflateStream.Read(System.Byte[],System.Int32,System.Int32)">
  112. <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
  113. <returns>The number of bytes that were read into the byte array.</returns>
  114. <param name="array">The array to store decompressed bytes.</param>
  115. <param name="offset">The byte offset in <paramref name="array" /> at which the read bytes will be placed.</param>
  116. <param name="count">The maximum number of decompressed bytes to read.</param>
  117. <exception cref="T:System.ArgumentNullException">
  118. <paramref name="array" /> is null.</exception>
  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>
  120. <exception cref="T:System.ArgumentOutOfRangeException">
  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>
  122. <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
  123. <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
  124. </member>
  125. <member name="M:System.IO.Compression.DeflateStream.Seek(System.Int64,System.IO.SeekOrigin)">
  126. <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  127. <returns>A long value.</returns>
  128. <param name="offset">The location in the stream.</param>
  129. <param name="origin">One of the <see cref="T:System.IO.SeekOrigin" /> values.</param>
  130. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  131. </member>
  132. <member name="M:System.IO.Compression.DeflateStream.SetLength(System.Int64)">
  133. <summary>This operation is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  134. <param name="value">The length of the stream.</param>
  135. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  136. </member>
  137. <member name="M:System.IO.Compression.DeflateStream.Write(System.Byte[],System.Int32,System.Int32)">
  138. <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
  139. <param name="array">The buffer that contains the data to compress.</param>
  140. <param name="offset">The byte offset in <paramref name="array" /> from which the bytes will be read.</param>
  141. <param name="count">The maximum number of bytes to write.</param>
  142. </member>
  143. <member name="T:System.IO.Compression.GZipStream">
  144. <summary>Provides methods and properties used to compress and decompress streams.</summary>
  145. </member>
  146. <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
  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>
  148. <param name="stream">The stream to write the compressed data to.</param>
  149. <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
  150. <exception cref="T:System.ArgumentNullException">
  151. <paramref name="stream" /> is null.</exception>
  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>
  153. </member>
  154. <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
  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>
  156. <param name="stream">The stream to write the compressed data to.</param>
  157. <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
  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>
  159. <exception cref="T:System.ArgumentNullException">
  160. <paramref name="stream" /> is null.</exception>
  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>
  162. </member>
  163. <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
  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>
  165. <param name="stream">The stream the compressed or decompressed data is written to.</param>
  166. <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
  167. <exception cref="T:System.ArgumentNullException">
  168. <paramref name="stream" /> is null.</exception>
  169. <exception cref="T:System.ArgumentException">
  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>
  171. </member>
  172. <member name="M:System.IO.Compression.GZipStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
  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>
  174. <param name="stream">The stream the compressed or decompressed data is written to.</param>
  175. <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
  176. <param name="leaveOpen">true to leave the stream open after disposing the <see cref="T:System.IO.Compression.GZipStream" /> object; otherwise, false.</param>
  177. <exception cref="T:System.ArgumentNullException">
  178. <paramref name="stream" /> is null.</exception>
  179. <exception cref="T:System.ArgumentException">
  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>
  181. </member>
  182. <member name="P:System.IO.Compression.GZipStream.BaseStream">
  183. <summary>Gets a reference to the underlying stream.</summary>
  184. <returns>A stream object that represents the underlying stream.</returns>
  185. <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
  186. <PermissionSet>
  187. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  188. </PermissionSet>
  189. </member>
  190. <member name="P:System.IO.Compression.GZipStream.CanRead">
  191. <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
  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>
  193. <PermissionSet>
  194. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  195. </PermissionSet>
  196. </member>
  197. <member name="P:System.IO.Compression.GZipStream.CanSeek">
  198. <summary>Gets a value indicating whether the stream supports seeking.</summary>
  199. <returns>false in all cases.</returns>
  200. </member>
  201. <member name="P:System.IO.Compression.GZipStream.CanWrite">
  202. <summary>Gets a value indicating whether the stream supports writing.</summary>
  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>
  204. <PermissionSet>
  205. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  206. </PermissionSet>
  207. </member>
  208. <member name="M:System.IO.Compression.GZipStream.Dispose(System.Boolean)">
  209. <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Compression.GZipStream" /> and optionally releases the managed resources.</summary>
  210. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  211. </member>
  212. <member name="M:System.IO.Compression.GZipStream.Flush">
  213. <summary>The current implementation of this method has no functionality.</summary>
  214. <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
  215. <PermissionSet>
  216. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  217. </PermissionSet>
  218. </member>
  219. <member name="P:System.IO.Compression.GZipStream.Length">
  220. <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  221. <returns>A long value.</returns>
  222. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  223. <PermissionSet>
  224. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  225. </PermissionSet>
  226. </member>
  227. <member name="P:System.IO.Compression.GZipStream.Position">
  228. <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  229. <returns>A long value.</returns>
  230. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  231. <PermissionSet>
  232. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  233. </PermissionSet>
  234. </member>
  235. <member name="M:System.IO.Compression.GZipStream.Read(System.Byte[],System.Int32,System.Int32)">
  236. <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
  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>
  238. <param name="array">The array used to store decompressed bytes.</param>
  239. <param name="offset">The byte offset in <paramref name="array" /> at which the read bytes will be placed.</param>
  240. <param name="count">The maximum number of decompressed bytes to read.</param>
  241. <exception cref="T:System.ArgumentNullException">
  242. <paramref name="array" /> is null.</exception>
  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>
  244. <exception cref="T:System.ArgumentOutOfRangeException">
  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>
  246. <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
  247. <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
  248. </member>
  249. <member name="M:System.IO.Compression.GZipStream.Seek(System.Int64,System.IO.SeekOrigin)">
  250. <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  251. <returns>A long value.</returns>
  252. <param name="offset">The location in the stream.</param>
  253. <param name="origin">One of the <see cref="T:System.IO.SeekOrigin" /> values.</param>
  254. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  255. </member>
  256. <member name="M:System.IO.Compression.GZipStream.SetLength(System.Int64)">
  257. <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
  258. <param name="value">The length of the stream.</param>
  259. <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
  260. </member>
  261. <member name="M:System.IO.Compression.GZipStream.Write(System.Byte[],System.Int32,System.Int32)">
  262. <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
  263. <param name="array">The buffer that contains the data to compress.</param>
  264. <param name="offset">The byte offset in <paramref name="array" /> from which the bytes will be read.</param>
  265. <param name="count">The maximum number of bytes to write.</param>
  266. <exception cref="T:System.ObjectDisposedException">The write operation cannot be performed because the stream is closed.</exception>
  267. </member>
  268. <member name="T:System.IO.Compression.ZipArchive">
  269. <summary>Represents a package of compressed files in the zip archive format.</summary>
  270. </member>
  271. <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream)">
  272. <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class from the specified stream.</summary>
  273. <param name="stream">The stream that contains the archive to be read.</param>
  274. <exception cref="T:System.ArgumentException">The stream is already closed or does not support reading.</exception>
  275. <exception cref="T:System.ArgumentNullException">
  276. <paramref name="stream" /> is null.</exception>
  277. <exception cref="T:System.IO.InvalidDataException">The contents of the stream are not in the zip archive format.</exception>
  278. </member>
  279. <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode)">
  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>
  281. <param name="stream">The input or output stream.</param>
  282. <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
  283. <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
  284. <exception cref="T:System.ArgumentNullException">
  285. <paramref name="stream" /> is null.</exception>
  286. <exception cref="T:System.ArgumentOutOfRangeException">
  287. <paramref name="mode" /> is an invalid value.</exception>
  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>
  289. </member>
  290. <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean)">
  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>
  292. <param name="stream">The input or output stream.</param>
  293. <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
  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>
  295. <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
  296. <exception cref="T:System.ArgumentNullException">
  297. <paramref name="stream" /> is null.</exception>
  298. <exception cref="T:System.ArgumentOutOfRangeException">
  299. <paramref name="mode" /> is an invalid value.</exception>
  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>
  301. </member>
  302. <member name="M:System.IO.Compression.ZipArchive.#ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean,System.Text.Encoding)">
  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>
  304. <param name="stream">The input or output stream.</param>
  305. <param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>
  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>
  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>
  308. <exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>
  309. <exception cref="T:System.ArgumentNullException">
  310. <paramref name="stream" /> is null.</exception>
  311. <exception cref="T:System.ArgumentOutOfRangeException">
  312. <paramref name="mode" /> is an invalid value.</exception>
  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>
  314. </member>
  315. <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String)">
  316. <summary>Creates an empty entry that has the specified path and entry name in the zip archive.</summary>
  317. <returns>An empty entry in the zip archive.</returns>
  318. <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
  319. <exception cref="T:System.ArgumentException">
  320. <paramref name="entryName" /> is <see cref="F:System.String.Empty" />.</exception>
  321. <exception cref="T:System.ArgumentNullException">
  322. <paramref name="entryName" /> is null.</exception>
  323. <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
  324. <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
  325. </member>
  326. <member name="M:System.IO.Compression.ZipArchive.CreateEntry(System.String,System.IO.Compression.CompressionLevel)">
  327. <summary>Creates an empty entry that has the specified entry name and compression level in the zip archive.</summary>
  328. <returns>An empty entry in the zip archive.</returns>
  329. <param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>
  330. <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
  331. <exception cref="T:System.ArgumentException">
  332. <paramref name="entryName" /> is <see cref="F:System.String.Empty" />.</exception>
  333. <exception cref="T:System.ArgumentNullException">
  334. <paramref name="entryName" /> is null.</exception>
  335. <exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>
  336. <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
  337. </member>
  338. <member name="M:System.IO.Compression.ZipArchive.Dispose">
  339. <summary>Releases the resources used by the current instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class.</summary>
  340. </member>
  341. <member name="M:System.IO.Compression.ZipArchive.Dispose(System.Boolean)">
  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>
  343. <param name="disposing">true to finish writing the archive and release unmanaged and managed resources; false to release only unmanaged resources.</param>
  344. </member>
  345. <member name="P:System.IO.Compression.ZipArchive.Entries">
  346. <summary>Gets the collection of entries that are currently in the zip archive.</summary>
  347. <returns>The collection of entries that are currently in the zip archive.</returns>
  348. <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
  349. <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
  350. <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
  351. </member>
  352. <member name="M:System.IO.Compression.ZipArchive.GetEntry(System.String)">
  353. <summary>Retrieves a wrapper for the specified entry in the zip archive.</summary>
  354. <returns>A wrapper for the specified entry in the archive; null if the entry does not exist in the archive.</returns>
  355. <param name="entryName">A path, relative to the root of the archive, that identifies the entry to retrieve.</param>
  356. <exception cref="T:System.ArgumentException">
  357. <paramref name="entryName" /> is <see cref="F:System.String.Empty" />.</exception>
  358. <exception cref="T:System.ArgumentNullException">
  359. <paramref name="entryName" /> is null.</exception>
  360. <exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>
  361. <exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>
  362. <exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>
  363. </member>
  364. <member name="P:System.IO.Compression.ZipArchive.Mode">
  365. <summary>Gets a value that describes the type of action the zip archive can perform on entries.</summary>
  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>
  367. </member>
  368. <member name="T:System.IO.Compression.ZipArchiveEntry">
  369. <summary>Represents a compressed file within a zip archive.</summary>
  370. </member>
  371. <member name="P:System.IO.Compression.ZipArchiveEntry.Archive">
  372. <summary>Gets the zip archive that the entry belongs to.</summary>
  373. <returns>The zip archive that the entry belongs to, or null if the entry has been deleted.</returns>
  374. </member>
  375. <member name="P:System.IO.Compression.ZipArchiveEntry.CompressedLength">
  376. <summary>Gets the compressed size of the entry in the zip archive.</summary>
  377. <returns>The compressed size of the entry in the zip archive.</returns>
  378. <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
  379. </member>
  380. <member name="M:System.IO.Compression.ZipArchiveEntry.Delete">
  381. <summary>Deletes the entry from the zip archive.</summary>
  382. <exception cref="T:System.IO.IOException">The entry is already open for reading or writing.</exception>
  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>
  384. <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
  385. </member>
  386. <member name="P:System.IO.Compression.ZipArchiveEntry.FullName">
  387. <summary>Gets the relative path of the entry in the zip archive.</summary>
  388. <returns>The relative path of the entry in the zip archive.</returns>
  389. </member>
  390. <member name="P:System.IO.Compression.ZipArchiveEntry.LastWriteTime">
  391. <summary>Gets or sets the last time the entry in the zip archive was changed.</summary>
  392. <returns>The last time the entry in the zip archive was changed.</returns>
  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>
  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>
  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>
  396. </member>
  397. <member name="P:System.IO.Compression.ZipArchiveEntry.Length">
  398. <summary>Gets the uncompressed size of the entry in the zip archive.</summary>
  399. <returns>The uncompressed size of the entry in the zip archive.</returns>
  400. <exception cref="T:System.InvalidOperationException">The value of the property is not available because the entry has been modified.</exception>
  401. </member>
  402. <member name="P:System.IO.Compression.ZipArchiveEntry.Name">
  403. <summary>Gets the file name of the entry in the zip archive.</summary>
  404. <returns>The file name of the entry in the zip archive.</returns>
  405. </member>
  406. <member name="M:System.IO.Compression.ZipArchiveEntry.Open">
  407. <summary>Opens the entry from the zip archive.</summary>
  408. <returns>The stream that represents the contents of the entry.</returns>
  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>
  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>
  411. <exception cref="T:System.ObjectDisposedException">The zip archive for this entry has been disposed.</exception>
  412. </member>
  413. <member name="M:System.IO.Compression.ZipArchiveEntry.ToString">
  414. <summary>Retrieves the relative path of the entry in the zip archive.</summary>
  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>
  416. </member>
  417. <member name="T:System.IO.Compression.ZipArchiveMode">
  418. <summary>Specifies values for interacting with zip archive entries.</summary>
  419. </member>
  420. <member name="F:System.IO.Compression.ZipArchiveMode.Create">
  421. <summary>Only creating new archive entries is permitted.</summary>
  422. </member>
  423. <member name="F:System.IO.Compression.ZipArchiveMode.Read">
  424. <summary>Only reading archive entries is permitted.</summary>
  425. </member>
  426. <member name="F:System.IO.Compression.ZipArchiveMode.Update">
  427. <summary>Both read and write operations are permitted for archive entries.</summary>
  428. </member>
  429. </members>
  430. </doc>