dotnet-api-docs/xml/System.IO.Compression/ZipArchive.xml at main · dotnet/dotnet-api-docs

History

928 lines (871 loc) · 64.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</TypeForwardingChain>

<Base>

<BaseTypeName>System.Object</BaseTypeName>

</Base>

<InterfaceName>System.IDisposable</InterfaceName>

</Interface>

<InterfaceName>System.IAsyncDisposable</InterfaceName>

</Interface>

</Interfaces>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Represents a package of compressed files in the zip archive format.</summary>

<format type="text/markdown"><![CDATA[

[!INCLUDE[remarks](~/includes/remarks/System.IO.Compression/ZipArchive/ZipArchive.md)]

]]></format>

</remarks>

</Docs>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="new System.IO.Compression.ZipArchive : System.IO.Stream -> System.IO.Compression.ZipArchive" Usage="new System.IO.Compression.ZipArchive stream" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="stream">The stream that contains the archive to be read.</param>

<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class from the specified stream.</summary>

<remarks>To be added.</remarks>

<exception cref="T:System.ArgumentException">The stream is already closed or does not support reading.</exception>

<exception cref="T:System.IO.InvalidDataException">The contents of the stream are not in the zip archive format.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.IO.Compression.ZipArchive : System.IO.Stream * System.IO.Compression.ZipArchiveMode -> System.IO.Compression.ZipArchive" Usage="new System.IO.Compression.ZipArchive (stream, mode)" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="stream">The input or output stream.</param>

<param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>

<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>

<format type="text/markdown"><![CDATA[

## Remarks

If the `mode` parameter is set to <xref:System.IO.Compression.ZipArchiveMode.Read>, the stream must support reading. If the `mode` parameter is set to <xref:System.IO.Compression.ZipArchiveMode.Create>, the stream must support writing. If the `mode` parameter is set to <xref:System.IO.Compression.ZipArchiveMode.Update>, the stream must support reading, writing, and seeking.

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>

<paramref name="mode" /> is an invalid value.</exception>

<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>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.IO.Compression.ZipArchive : System.IO.Stream * System.IO.Compression.ZipArchiveMode * bool -> System.IO.Compression.ZipArchive" Usage="new System.IO.Compression.ZipArchive (stream, mode, leaveOpen)" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="stream">The input or output stream.</param>

<param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>

<see langword="true" /> to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive" /> object is disposed; otherwise, <see langword="false" />.</param>

<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>

<format type="text/markdown"><![CDATA[

## Remarks

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.</exception>

<paramref name="mode" /> is an invalid value.</exception>

<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>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.IO.Compression.ZipArchive : System.IO.Stream * System.IO.Compression.ZipArchiveMode * bool * System.Text.Encoding -> System.IO.Compression.ZipArchive" Usage="new System.IO.Compression.ZipArchive (stream, mode, leaveOpen, entryNameEncoding)" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="stream">The input or output stream.</param>

<param name="mode">One of the enumeration values that indicates whether the zip archive is used to read, create, or update entries.</param>

<see langword="true" /> to leave the stream open after the <see cref="T:System.IO.Compression.ZipArchive" /> object is disposed; otherwise, <see langword="false" />.</param>

<param name="entryNameEncoding">The encoding to use when reading or writing entry names and comments 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 or comments.</param>

<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>

<format type="text/markdown"><![CDATA[

[!INCLUDE[remarks](~/includes/remarks/System.IO.Compression/ZipArchive/.ctor_Stream_ZipArchiveMode_Boolean_Encoding.md)]

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">The stream is already closed, or the capabilities of the stream do not match the mode.

-or-

An encoding other than UTF-8 is specified for the <paramref name="entryNameEncoding" />.</exception>

<paramref name="mode" /> is an invalid value.</exception>

<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>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.String</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets or sets the optional archive comment.</summary>

<value>To be added.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The comment encoding is determined by the `entryNameEncoding` parameter of the <xref:System.IO.Compression.ZipArchive.%23ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean,System.Text.Encoding)> constructor.

If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will be truncated when disposing the archive.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<System.IO.Compression.ZipArchive> CreateAsync (System.IO.Stream stream, System.IO.Compression.ZipArchiveMode mode, bool leaveOpen, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class System.IO.Compression.ZipArchive> CreateAsync(class System.IO.Stream stream, valuetype System.IO.Compression.ZipArchiveMode mode, bool leaveOpen, class System.Text.Encoding entryNameEncoding, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="F#" Value="static member CreateAsync : System.IO.Stream * System.IO.Compression.ZipArchiveMode * bool * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Compression.ZipArchive>" Usage="System.IO.Compression.ZipArchive.CreateAsync (stream, mode, leaveOpen, entryNameEncoding, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Threading.Tasks.Task<System.IO.Compression.ZipArchive></ReturnType>

</ReturnValue>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="stream">The input or output stream.</param>

<param name="mode">One of the enumeration values that specifies whether the stream supports reading, writing, and seeking.</param>

<see langword="true" /> to leave the stream open upon disposing the ZipArchive, otherwise <see langword="false" />.</param>

The encoding to use when reading or writing entry names and comments in this ZipArchive.

</param>

<param name="cancellationToken">The optional cancellation token to monitor.</param>

<summary>Asynchronously initializes and returns a new instance of <see cref="T:System.IO.Compression.ZipArchive" /> on the given stream in the specified mode, specifying whether to leave the stream open, with an optional encoding and an optional cancellation token.</summary>

<returns>To be added.</returns>

<para>Specifying a value for <paramref name="entryNameEncoding" /> other than <see langword="null" /> is discouraged. However, this might be necessary for interoperability with ZIP archive tools and libraries that don't correctly support UTF-8 encoding for entry names.</para>

<para>This value is used as follows:</para>

<dl>

<li>

Reading (opening) ZIP archive files:

<ul>

<li>If <paramref name="entryNameEncoding" /> is not specified (<c>== null</c>):

<ul><li>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is not set, use the current system default code page (<c>Encoding.Default</c>) to decode the entry name and comment.</li><li>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is set, use UTF-8 (<c>Encoding.UTF8</c>) to decode the entry name and comment.</li></ul></li>

<li>If <paramref name="entryNameEncoding" /> is specified (<c>!= null</c>):

<ul><li>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is not set, use the specified <paramref name="entryNameEncoding" /> to decode the entry name and comment.</li><li>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is set, use UTF-8 (<c>Encoding.UTF8</c>) to decode the entry name and comment.</li></ul></li>

</ul>

</li>

<li>

Writing (saving) ZIP archive files:

<ul>

<li>If <paramref name="entryNameEncoding" /> is not specified (<c>== null</c>):

<ul><li>For entry names and comments that contain characters outside the ASCII range, the language encoding flag (EFS) will be set in the general purpose bit flag of the local file header, and UTF-8 (<c>Encoding.UTF8</c>) will be used to encode the entry name and comment into bytes.</li><li>For entry names and comments that don't contain characters outside the ASCII range, the language encoding flag (EFS) will not be set in the general purpose bit flag of the local file header, and the current system default code page (<c>Encoding.Default</c>) will be used to encode the entry names and comments into bytes.</li></ul></li>

<li>If <paramref name="entryNameEncoding" /> is specified (<c>!= null</c>):

<ul><li>The specified <paramref name="entryNameEncoding" /> will always be used to encode the entry names and comments into bytes.</li><li>The language encoding flag (EFS) in the general purpose bit flag of the local file header will be set if and only if the specified <paramref name="entryNameEncoding" /> is a UTF-8 encoding.</li></ul></li>

</ul>

</li>

</dl>

</remarks>

<para>The stream is already closed.</para>

<para>

<paramref name="mode" /> is incompatible with the capabilities of the stream.</para>

</exception>

<exception cref="T:System.ArgumentNullException">The stream is <see langword="null" />.</exception>

<paramref name="mode" /> specified an invalid value.</exception>

<para>The contents of the stream could not be interpreted as a ZIP file.</para>

<para>

<paramref name="mode" /> is Update and an entry is missing from the archive or is corrupt and cannot be read.</para>

<para>

<paramref name="mode" /> is Update and an entry is too large to fit into memory.</para>

</exception>

<exception cref="T:System.ArgumentException">A Unicode encoding other than UTF-8 was specified for <paramref name="entryNameEncoding" />.</exception>

</Docs>

</Member>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Creates an empty entry in the zip archive.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="member this.CreateEntry : string -> System.IO.Compression.ZipArchiveEntry" Usage="zipArchive.CreateEntry entryName" />

<MemberType>Method</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.IO.Compression.ZipArchiveEntry</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>

<summary>Creates an empty entry that has the specified path and entry name in the zip archive.</summary>

<returns>An empty entry in the zip archive.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The `entryName` string should reflect the relative path of the entry you want to create within the zip archive. There is no restriction on the string you provide. However, if it is not formatted as a relative path, the entry is created, but you may get an exception when you extract the contents of the zip archive. If an entry with the specified path and name already exists in the archive, a second entry is created with the same path and name.

The value of the <xref:System.IO.Compression.ZipArchiveEntry.LastWriteTime> property for the new entry is set to the current time. The entry is compressed using the default compression level of the underlying compression algorithm. If you want to specify a different compression level, use the <xref:System.IO.Compression.ZipArchive.CreateEntry%2A> method.

## Examples

The following example shows how to create an entry and write to it by using a stream.

:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/CreateEntry/program1.cs" id="Snippet1":::

:::code language="fsharp" source="~/snippets/fsharp/System.IO.Compression/ZipArchive/CreateEntry/program1.fs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/ZipArchive/CreateEntry/program1.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>

<exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.CreateEntry : string * System.IO.Compression.CompressionLevel -> System.IO.Compression.ZipArchiveEntry" Usage="zipArchive.CreateEntry (entryName, compressionLevel)" />

<MemberType>Method</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.IO.Compression.ZipArchiveEntry</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="entryName">A path, relative to the root of the archive, that specifies the name of the entry to be created.</param>

<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>

<summary>Creates an empty entry that has the specified entry name and compression level in the zip archive.</summary>

<returns>An empty entry in the zip archive.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The `entryName` string should reflect the relative path of the entry you want to create within the zip archive. There is no restriction on the string you provide. However, if it is not formatted as a relative path, the entry is created, but you may get an exception when you extract the contents of the zip archive. If an entry with the specified name already exists in the archive, a second entry is created with the same name.

The value of the <xref:System.IO.Compression.ZipArchiveEntry.LastWriteTime> property for the new entry is set to the current time. Set the `compressionLevel` parameter to <xref:System.IO.Compression.CompressionLevel.Optimal> if you want the file to be compressed as much as possible. Set the `compressionLevel` parameter to <xref:System.IO.Compression.CompressionLevel.Fastest> only if you are concerned that the compression operation will not complete quickly enough for your scenario.

## Examples

The following example shows how to create an entry with the optimal compression level. It also writes to the new entry by using a stream.

:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/CreateEntry/program2.cs" id="Snippet2":::

:::code language="fsharp" source="~/snippets/fsharp/System.IO.Compression/ZipArchive/CreateEntry/program2.fs" id="Snippet2":::

:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/ZipArchive/CreateEntry/program2.vb" id="Snippet2":::

]]></format>

</remarks>

<exception cref="T:System.NotSupportedException">The zip archive does not support writing.</exception>

<exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>

</Docs>

</Member>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Releases all resources used by the <see cref="T:System.IO.Compression.ZipArchive" /> object.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="zipArchive.Dispose " />

<MemberType>Method</MemberType>

<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>

</Implements>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Docs>

<summary>Releases the resources used by the current instance of the <see cref="T:System.IO.Compression.ZipArchive" /> class.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This method finishes writing the archive and releases all resources used by the <xref:System.IO.Compression.ZipArchive> object. Unless you construct the object by using the <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%2CSystem.Boolean%29> constructor overload and set its `leaveOpen` parameter to `true`, all underlying streams are closed and no longer available for subsequent write operations.

When you are finished using this instance of <xref:System.IO.Compression.ZipArchive>, call <xref:System.IO.Compression.ZipArchive.Dispose> to release all resources used by this instance. You should eliminate further references to this <xref:System.IO.Compression.ZipArchive> instance so that the garbage collector can reclaim the memory of the instance instead of keeping it alive for finalization.

<xref:System.IO.Compression.ZipArchive.Dispose> calls the <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> method, which contains the code to release managed and unmanaged resources. For more information, see [Implementing a Dispose method](/dotnet/standard/garbage-collection/implementing-dispose).

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="zipArchive.Dispose disposing" />

<MemberType>Method</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<see langword="true" /> to finish writing the archive and release unmanaged and managed resources; <see langword="false" /> to release only unmanaged resources.</param>

<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>

<format type="text/markdown"><![CDATA[

## Remarks

If `disposing` is set to `true`, all underlying streams are closed and no longer available for subsequent write operations, unless you construct the object by using the <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%2CSystem.Boolean%29> constructor overload and set its `leaveOpen` parameter to `true`.

This method is called only by the public <xref:System.IO.Compression.ZipArchive.Dispose> and <xref:System.Object.Finalize> methods; do not call this method directly.

When you implement the dispose pattern, the Boolean parameter of the <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> method should be used as follows:

- The <xref:System.IO.Compression.ZipArchive.Dispose> method of the current object should call <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> with the Boolean parameter set to `true` to release both managed and unmanaged resources.

- The <xref:System.Object.Finalize> method of the current object should call <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> with the Boolean parameter set to `false` to release only unmanaged resources.

For more information, see [Implementing a Dispose method](/dotnet/standard/garbage-collection/implementing-dispose).

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask" Usage="zipArchive.DisposeAsync " />

<MemberType>Method</MemberType>

<InterfaceMember>M:System.IAsyncDisposable.DisposeAsync</InterfaceMember>

</Implements>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>

</ReturnValue>

<Docs>

<summary>To be added.</summary>

<returns>To be added.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member DisposeAsyncCore : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsyncCore : unit -> System.Threading.Tasks.ValueTask" Usage="zipArchive.DisposeAsyncCore " />

<MemberType>Method</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>

</ReturnValue>

<Docs>

<summary>To be added.</summary>

<returns>To be added.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.ReadOnlyCollection<System.IO.Compression.ZipArchiveEntry> Entries { get; }" />

<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class System.IO.Compression.ZipArchiveEntry> Entries" />

<MemberSignature Language="F#" Value="member this.Entries : System.Collections.ObjectModel.ReadOnlyCollection<System.IO.Compression.ZipArchiveEntry>" Usage="System.IO.Compression.ZipArchive.Entries" />

<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::ReadOnlyCollection<System::IO::Compression::ZipArchiveEntry ^> ^ Entries { System::Collections::ObjectModel::ReadOnlyCollection<System::IO::Compression::ZipArchiveEntry ^> ^ get(); };" />

<MemberType>Property</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<System.IO.Compression.ZipArchiveEntry></ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the collection of entries that are currently in the zip archive.</summary>

<value>The collection of entries that are currently in the zip archive.</value>

<format type="text/markdown"><![CDATA[

## Remarks

Use the <xref:System.IO.Compression.ZipArchive.Entries> property to retrieve the entire collection of entries. Use the <xref:System.IO.Compression.ZipArchive.GetEntry%2A> method to retrieve a single entry by name.

## Examples

The following example shows how to open a zip archive and iterate through the collection of entries.

:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/Entries/program1.cs" id="Snippet1":::

:::code language="fsharp" source="~/snippets/fsharp/System.IO.Compression/ZipArchive/Entries/program1.fs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/ZipArchive/Entries/program1.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>

<exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>

<exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.GetEntry : string -> System.IO.Compression.ZipArchiveEntry" Usage="zipArchive.GetEntry entryName" />

<MemberType>Method</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.IO.Compression.ZipArchiveEntry</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="entryName">A path, relative to the root of the archive, that identifies the entry to retrieve.</param>

<summary>Retrieves a wrapper for the specified entry in the zip archive.</summary>

<returns>A wrapper for the specified entry in the archive; <see langword="null" /> if the entry does not exist in the archive.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

If multiple entries that have the specified name exist in the archive, the first one is returned. The name of the entry is compared to `entryName` using ordinal comparison.

## Examples

The following example shows how to use the <xref:System.IO.Compression.ZipArchive.GetEntry%2A> method to retrieve an entry.

:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/GetEntry/program2.cs" id="Snippet2":::

:::code language="fsharp" source="~/snippets/fsharp/System.IO.Compression/ZipArchive/GetEntry/program2.fs" id="Snippet2":::

:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/ZipArchive/GetEntry/program2.vb" id="Snippet2":::

]]></format>

</remarks>

<exception cref="T:System.NotSupportedException">The zip archive does not support reading.</exception>

<exception cref="T:System.ObjectDisposedException">The zip archive has been disposed.</exception>

<exception cref="T:System.IO.InvalidDataException">The zip archive is corrupt, and its entries cannot be retrieved.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System.IO.Compression</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.IO.Compression.ZipArchiveMode</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets a value that describes the type of action the zip archive can perform on entries.</summary>

<value>One of the enumeration values that describes the type of action (read, create, or update) the zip archive can perform on entries.</value>

<format type="text/markdown"><![CDATA[

## Remarks

You specify a value for the <xref:System.IO.Compression.ZipArchive> property when you create an instance of the <xref:System.IO.Compression.ZipArchive> class. Use the <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%29> or <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%2CSystem.Boolean%29> constructor to provide a value for the <xref:System.IO.Compression.ZipArchive.Mode> property.

]]></format>

</remarks>

</Docs>

</Member>

</Members>

</Type>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

ZipArchive.xml

Latest commit

History

ZipArchive.xml

File metadata and controls