ZipArchive ZipArchive ZipArchive ZipArchive Class

定義

zip アーカイブ形式の圧縮ファイルのパッケージを表します。Represents a package of compressed files in the zip archive format.

public ref class ZipArchive : IDisposable
public class ZipArchive : IDisposable
type ZipArchive = class
    interface IDisposable
Public Class ZipArchive
Implements IDisposable
継承
ZipArchiveZipArchiveZipArchiveZipArchive
実装

最初の例では、新しいエントリを作成し、ストリームを使用して書き込む方法を示します。The first example shows how to create a new entry and write to it by using a stream.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            using (FileStream zipToOpen = new FileStream(@"c:\users\exampleuser\release.zip", FileMode.Open))
            {
                using (ZipArchive archive = new ZipArchive(zipToOpen, ZipArchiveMode.Update))
                {
                    ZipArchiveEntry readmeEntry = archive.CreateEntry("Readme.txt");
                    using (StreamWriter writer = new StreamWriter(readmeEntry.Open()))
                    {
                            writer.WriteLine("Information about this package.");
                            writer.WriteLine("========================");
                    }
                }
            }
        }
    }
}
Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Using zipToOpen As FileStream = New FileStream("c:\users\exampleuser\release.zip", FileMode.Open)
            Using archive As ZipArchive = New ZipArchive(zipToOpen, ZipArchiveMode.Update)
                Dim readmeEntry As ZipArchiveEntry = archive.CreateEntry("Readme.txt")
                Using writer As StreamWriter = New StreamWriter(readmeEntry.Open())
                    writer.WriteLine("Information about this package.")
                    writer.WriteLine("========================")
                End Using
            End Using
        End Using
    End Sub

End Module

次の例では、zip アーカイブを開き、エントリのコレクションを反復処理する方法を示します。The following example shows how to open a zip archive and iterate through the collection of entries.

using System;
using System.IO;
using System.IO.Compression;

class Program
{
    static void Main(string[] args)
    {
        string zipPath = @".\result.zip";

        Console.WriteLine("Provide path where to extract the zip file:");
        string extractPath = Console.ReadLine();

        // Normalizes the path.
        extractPath = Path.GetFullPath(extractPath);

        // Ensures that the last character on the extraction path
        // is the directory separator char. 
        // Without this, a malicious zip file could try to traverse outside of the expected
        // extraction path.
        if (!extractPath.EndsWith(Path.DirectorySeparatorChar.ToString(), StringComparison.Ordinal))
            extractPath += Path.DirectorySeparatorChar;

        using (ZipArchive archive = ZipFile.OpenRead(zipPath))
        {
            foreach (ZipArchiveEntry entry in archive.Entries)
            {
                if (entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase))
                {
                    // Gets the full path to ensure that relative segments are removed.
                    string destinationPath = Path.GetFullPath(Path.Combine(extractPath, entry.FullName));

                    // Ordinal match is safest, case-sensitive volumes can be mounted within volumes that
                    // are case-insensitive.
                    if (destinationPath.StartsWith(extractPath, StringComparison.Ordinal))
                        entry.ExtractToFile(destinationPath);
                }
            }
        }
    }
}
Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Dim zipPath As String = ".\result.zip"

        Console.WriteLine("Provide path where to extract the zip file:")
        Dim extractPath As String = Console.ReadLine()

        ' Normalizes the path.
        extractPath = Path.GetFullPath(extractPath)

        ' Ensures that the last character on the extraction path
        ' is the directory separator char. 
        ' Without this, a malicious zip file could try to traverse outside of the expected
        ' extraction path.
        If Not extractPath.EndsWith(Path.DirectorySeparatorChar.ToString(), StringComparison.Ordinal) Then
            extractPath += Path.DirectorySeparatorChar
        End If

        Using archive As ZipArchive = ZipFile.OpenRead(zipPath)
            For Each entry As ZipArchiveEntry In archive.Entries
                If entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase) Then

                    ' Gets the full path to ensure that relative segments are removed.
                    Dim destinationPath As String = Path.GetFullPath(Path.Combine(extractPath, entry.FullName))
                    
                    ' Ordinal match is safest, case-sensitive volumes can be mounted within volumes that
                    ' are case-insensitive.
                    If destinationPath.StartsWith(extractPath, StringComparison.Ordinal) Then 
                        entry.ExtractToFile(destinationPath)
                    End If

                End If
            Next
        End Using
    End Sub

End Module

3 番目の例では、既存のファイルから、zip アーカイブ内の新しいエントリを作成し、アーカイブの内容を抽出する拡張メソッドを使用する方法を示します。The third example shows how to use extension methods to create a new entry in a zip archive from an existing file and extract the archive contents. 参照する必要があります、System.IO.Compression.FileSystemアセンブリ コードを実行します。You must reference the System.IO.Compression.FileSystem assembly to execute the code.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string zipPath = @"c:\users\exampleuser\start.zip";
            string extractPath = @"c:\users\exampleuser\extract";
            string newFile = @"c:\users\exampleuser\NewFile.txt";
            
            using (ZipArchive archive = ZipFile.Open(zipPath, ZipArchiveMode.Update))
            {
                archive.CreateEntryFromFile(newFile, "NewEntry.txt");
                archive.ExtractToDirectory(extractPath);
            } 
        }
    }
}
Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Dim zipPath As String = "c:\users\exampleuser\end.zip"
        Dim extractPath As String = "c:\users\exampleuser\extract"
        Dim newFile As String = "c:\users\exampleuser\NewFile.txt"

        Using archive As ZipArchive = ZipFile.Open(zipPath, ZipArchiveMode.Update)
            archive.CreateEntryFromFile(newFile, "NewEntry.txt", CompressionLevel.Fastest)
            archive.ExtractToDirectory(extractPath)
        End Using
    End Sub

End Module

注釈

Zip アーカイブし、そのファイルのエントリを操作するためのメソッドが 3 つのクラスに分散: ZipFileZipArchive、およびZipArchiveEntryします。The methods for manipulating zip archives and their file entries are spread across three classes: ZipFile, ZipArchive, and ZipArchiveEntry.

目的To 使用Use
ディレクトリから zip アーカイブを作成します。Create a zip archive from a directory ZipFile.CreateFromDirectory
ディレクトリの zip アーカイブの内容を抽出します。Extract the contents of a zip archive to a directory ZipFile.ExtractToDirectory
新しいファイルを既存の zip アーカイブに追加します。Add new files to an existing zip archive ZipArchive.CreateEntry
Zip アーカイブからファイルを取得します。Retrieve a file from a zip archive ZipArchive.GetEntry
Zip アーカイブからのすべてのファイルを取得します。Retrieve all the files from a zip archive ZipArchive.Entries
Zip アーカイブに含まれる 1 つのファイル ストリームを開くOpen a stream to a single file contained in a zip archive ZipArchiveEntry.Open
Zip アーカイブからファイルを削除します。Delete a file from a zip archive ZipArchiveEntry.Delete

新しいエントリを作成するときに、ファイルが圧縮し、zip パッケージに追加します。When you create a new entry, the file is compressed and added to the zip package. CreateEntryメソッドでは、エントリを追加するときに、ディレクトリ階層を指定することができます。The CreateEntry method enables you to specify a directory hierarchy when adding the entry. Zip パッケージ内で新しいエントリの相対パスが含まれます。You include the relative path of the new entry within the zip package. たとえば、新しいエントリを作成するとの相対パスAddedFolder\NewFile.txtAddedFolder という名前のディレクトリに圧縮されたテキスト ファイルを作成します。For example, creating a new entry with a relative path of AddedFolder\NewFile.txt creates a compressed text file in a directory named AddedFolder.

参照する場合、System.IO.Compression.FileSystemアセンブリ プロジェクトで、次の 4 つの拡張機能メソッドにアクセスすることができます (から、ZipFileExtensionsクラス) のZipArchiveクラス: CreateEntryFromFile(ZipArchive, String, String)CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)ExtractToDirectory(ZipArchive, String)、およびExtractToDirectory(ZipArchive, String, Boolean)(.NET で使用できます。Core 2.0 およびそれ以降のバージョン)。If you reference the System.IO.Compression.FileSystem assembly in your project, you can access four extension methods (from the ZipFileExtensions class) for the ZipArchive class: CreateEntryFromFile(ZipArchive, String, String), CreateEntryFromFile(ZipArchive, String, String, CompressionLevel), ExtractToDirectory(ZipArchive, String), and ExtractToDirectory(ZipArchive, String, Boolean) (available in .NET Core 2.0 and later versions). これらの拡張メソッドを使用すると、圧縮およびファイルにエントリの内容を展開できます。These extension methods enable you to compress and decompress the contents of the entry to a file. System.IO.Compression.FileSystemアセンブリは使用できませんWindows 8.x ストアWindows 8.x Storeアプリ。The System.IO.Compression.FileSystem assembly is not available for Windows 8.x ストアWindows 8.x Store apps. Windows 8.x ストアWindows 8.x Storeアプリ、圧縮およびを使用してファイルを展開することができます、DeflateStreamまたはGZipStreamクラス、またはを使用できる、Windows ランタイムWindows Runtime圧縮伸張します。In Windows 8.x ストアWindows 8.x Store apps, you can compress and decompress files by using the DeflateStream or GZipStream class, or you can use the Windows ランタイムWindows Runtime types Compressor and Decompressor.

コンストラクター

ZipArchive(Stream) ZipArchive(Stream) ZipArchive(Stream) ZipArchive(Stream)

新しいインスタンスを初期化、ZipArchive指定したストリームからのクラス。Initializes a new instance of the ZipArchive class from the specified stream.

ZipArchive(Stream, ZipArchiveMode) ZipArchive(Stream, ZipArchiveMode) ZipArchive(Stream, ZipArchiveMode) ZipArchive(Stream, ZipArchiveMode)

新しいインスタンスを初期化、ZipArchiveクラス指定したストリームからと、指定したモード。Initializes a new instance of the ZipArchive class from the specified stream and with the specified mode.

ZipArchive(Stream, ZipArchiveMode, Boolean) ZipArchive(Stream, ZipArchiveMode, Boolean) ZipArchive(Stream, ZipArchiveMode, Boolean) ZipArchive(Stream, ZipArchiveMode, Boolean)

新しいインスタンスを初期化、ZipArchiveで指定したモード、および必要に応じて、ストリームを開いたまま、指定したストリーム クラス。Initializes a new instance of the ZipArchive class on the specified stream for the specified mode, and optionally leaves the stream open.

ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding) ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding) ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding) ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding)

新しいインスタンスを初期化、ZipArchiveクラスが指定されたモードの指定されたストリームで、エントリ名の指定したエンコーディングを使用して、ストリームを開いたまま必要に応じて。Initializes a new instance of the ZipArchive class on the specified stream for the specified mode, uses the specified encoding for entry names, and optionally leaves the stream open.

プロパティ

Entries Entries Entries Entries

現在 zip アーカイブ内にあるエントリのコレクションを取得します。Gets the collection of entries that are currently in the zip archive.

Mode Mode Mode Mode

zip アーカイブがエントリで実行できる操作の種類を示す値を取得します。Gets a value that describes the type of action the zip archive can perform on entries.

メソッド

CreateEntry(String) CreateEntry(String) CreateEntry(String) CreateEntry(String)

指定したパスとエントリ名を持つ空のエントリを zip アーカイブに作成します。Creates an empty entry that has the specified path and entry name in the zip archive.

CreateEntry(String, CompressionLevel) CreateEntry(String, CompressionLevel) CreateEntry(String, CompressionLevel) CreateEntry(String, CompressionLevel)

指定したエントリ名と圧縮レベルを持つ空のエントリを zip アーカイブに作成します。Creates an empty entry that has the specified entry name and compression level in the zip archive.

Dispose() Dispose() Dispose() Dispose()

ZipArchive クラスの現在のインスタンスによって使用されているリソースを解放します。Releases the resources used by the current instance of the ZipArchive class.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

メソッドを呼び出して、Dispose()Finalize()の現在のインスタンスによって使用されるアンマネージ リソースを解放するメソッド、ZipArchiveクラス、および必要に応じて、アーカイブの書き込みが完了し、マネージ リソースも解放します。Called by the Dispose() and Finalize() methods to release the unmanaged resources used by the current instance of the ZipArchive class, and optionally finishes writing the archive and releases the managed resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetEntry(String) GetEntry(String) GetEntry(String) GetEntry(String)

zip アーカイブ内の指定したエントリのラッパーを取得します。Retrieves a wrapper for the specified entry in the zip archive.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

Extension Methods

CreateEntryFromFile(ZipArchive, String, String) CreateEntryFromFile(ZipArchive, String, String) CreateEntryFromFile(ZipArchive, String, String) CreateEntryFromFile(ZipArchive, String, String)

ファイルを圧縮し、zip アーカイブに追加することでアーカイブします。Archives a file by compressing it and adding it to the zip archive.

CreateEntryFromFile(ZipArchive, String, String, CompressionLevel) CreateEntryFromFile(ZipArchive, String, String, CompressionLevel) CreateEntryFromFile(ZipArchive, String, String, CompressionLevel) CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)

指定した圧縮レベルを使用して、zip アーカイブに追加して、圧縮することで、ファイルをアーカイブします。Archives a file by compressing it using the specified compression level and adding it to the zip archive.

ExtractToDirectory(ZipArchive, String) ExtractToDirectory(ZipArchive, String) ExtractToDirectory(ZipArchive, String) ExtractToDirectory(ZipArchive, String)

zip アーカイブのすべてのファイルをファイル システムのディレクトリに抽出します。Extracts all the files in the zip archive to a directory on the file system.

ExtractToDirectory(ZipArchive, String, Boolean) ExtractToDirectory(ZipArchive, String, Boolean) ExtractToDirectory(ZipArchive, String, Boolean) ExtractToDirectory(ZipArchive, String, Boolean)

すべてのファイル システム上のディレクトリにアーカイブ ファイルを抽出します。Extracts all of the files in the archive to a directory on the file system.

適用対象

こちらもご覧ください