ZipArchive Classe

Définition

Représente un package de fichiers compressés au format d'archivage 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
Héritage
ZipArchive
Implémente

Exemples

Le premier exemple montre comment créer une nouvelle entrée et y écrire à l’aide d’un flux.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

L’exemple suivant montre comment ouvrir une archive zip et itérer au sein de la collection d’entrées.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

Le troisième exemple montre comment utiliser des méthodes d’extension pour créer une entrée dans une archive zip à partir d’un fichier existant et comment extraire le contenu de l’archive.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. Vous devez référencer System.IO.Compression.FileSystem l’assembly pour exécuter le code.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

Remarques

Les méthodes de manipulation des archives zip et leurs entrées de fichier sont réparties entre ZipFiletrois ZipArchiveclasses: ZipArchiveEntry, et.The methods for manipulating zip archives and their file entries are spread across three classes: ZipFile, ZipArchive, and ZipArchiveEntry.

ÀTo UtilisezUse
Créer une archive zip à partir d’un répertoireCreate a zip archive from a directory ZipFile.CreateFromDirectory
Extraire le contenu d’une archive zip dans un répertoireExtract the contents of a zip archive to a directory ZipFile.ExtractToDirectory
Ajouter de nouveaux fichiers à une archive zip existanteAdd new files to an existing zip archive ZipArchive.CreateEntry
Récupérer un fichier à partir d’une archive zipRetrieve a file from a zip archive ZipArchive.GetEntry
Récupérer tous les fichiers d’une archive zipRetrieve all the files from a zip archive ZipArchive.Entries
Ouvrir un flux dans un fichier unique contenu dans une archive zipOpen a stream to a single file contained in a zip archive ZipArchiveEntry.Open
Supprimer un fichier d’une archive zipDelete a file from a zip archive ZipArchiveEntry.Delete

Lorsque vous créez une nouvelle entrée, le fichier est compressé et ajouté au package zip.When you create a new entry, the file is compressed and added to the zip package. La CreateEntry méthode vous permet de spécifier une hiérarchie de répertoires lors de l’ajout de l’entrée.The CreateEntry method enables you to specify a directory hierarchy when adding the entry. Vous incluez le chemin d’accès relatif de la nouvelle entrée dans le package zip.You include the relative path of the new entry within the zip package. Par exemple, la création d’une entrée avec un chemin d' AddedFolder\NewFile.txt accès relatif de crée un fichier texte compressé dans un répertoire nommé AddedFolder.For example, creating a new entry with a relative path of AddedFolder\NewFile.txt creates a compressed text file in a directory named AddedFolder.

Si vous référencez System.IO.Compression.FileSystem l’assembly dans votre projet, vous pouvez accéder à quatre méthodes d' ZipFileExtensions extension (à partir de la CreateEntryFromFile(ZipArchive, String, String)classe CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)) ExtractToDirectory(ZipArchive, String)pour la ExtractToDirectory(ZipArchive, String, Boolean) ZipArchive classe:,, et (disponible dans .net Core 2,0 et versions ultérieures).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). Ces méthodes d’extension vous permettent de compresser et de décompresser le contenu de l’entrée dans un fichier.These extension methods enable you to compress and decompress the contents of the entry to a file. L' System.IO.Compression.FileSystem assembly n’est pas Windows 8.x StoreWindows 8.x Store disponible pour les applications.The System.IO.Compression.FileSystem assembly is not available for Windows 8.x StoreWindows 8.x Store apps. Dans Windows 8.x StoreWindows 8.x Store les applications, vous pouvez compresser et décompresser DeflateStream des fichiers à l’aide de la classe Windows RuntimeWindows Runtime GZipStream ou, ou vous pouvez utiliser les types compresseur et décompresseur. In Windows 8.x StoreWindows 8.x Store apps, you can compress and decompress files by using the DeflateStream or GZipStream class, or you can use the Windows RuntimeWindows Runtime types Compressor and Decompressor.

Constructeurs

ZipArchive(Stream)

Initialise une nouvelle instance de la classe ZipArchive à partir du flux spécifié.Initializes a new instance of the ZipArchive class from the specified stream.

ZipArchive(Stream, ZipArchiveMode)

Initialise une nouvelle instance de la classe ZipArchive à partir du flux spécifié et avec le mode spécifié.Initializes a new instance of the ZipArchive class from the specified stream and with the specified mode.

ZipArchive(Stream, ZipArchiveMode, Boolean)

Initialise une nouvelle instance de la classe ZipArchive sur le flux de données spécifié pour le mode spécifié, et laisse éventuellement le flux ouvert.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)

Initialise une nouvelle instance de la classe ZipArchive sur le flux spécifié pour le mode spécifié, utilise l’encodage spécifié pour les noms d’entrée, et permet éventuellement de laisser le flux ouvert.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.

Propriétés

Entries

Obtient la collection d'entrées figurant actuellement dans l'archive ZIP.Gets the collection of entries that are currently in the zip archive.

Mode

Obtient une valeur qui décrit le type d'action que l'archive zip peut exécuter sur des entrées.Gets a value that describes the type of action the zip archive can perform on entries.

Méthodes

CreateEntry(String)

Crée une entrée vide qui porte le chemin d'accès et le nom d'entrée spécifiés dans l'archive zip.Creates an empty entry that has the specified path and entry name in the zip archive.

CreateEntry(String, CompressionLevel)

Crée une entrée vide qui porte le nom d'entrée et le niveau de compression spécifiés dans l'archive zip.Creates an empty entry that has the specified entry name and compression level in the zip archive.

Dispose()

Libère les ressources utilisées par l'instance actuelle de la classe ZipArchive.Releases the resources used by the current instance of the ZipArchive class.

Dispose(Boolean)

Appelée par les méthodes Dispose() et Finalize() pour libérer les ressources non managées utilisées par l’instance actuelle de la classe ZipArchive, et éventuellement finit d’écrire l’archive et libère les ressources managées.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)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Hérité de Object)
GetEntry(String)

Récupère un wrapper pour l'entrée spécifiée dans l'archive Zip.Retrieves a wrapper for the specified entry in the zip archive.

GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Hérité de Object)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Hérité de Object)

Méthodes d’extension

CreateEntryFromFile(ZipArchive, String, String)

Archive un fichier en le compressant et en l'ajoutant à l'archive ZIP.Archives a file by compressing it and adding it to the zip archive.

CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)

Archive un fichier en le compressant à l'aide du niveau de compression spécifié et en l'ajoutant à l'archive ZIP.Archives a file by compressing it using the specified compression level and adding it to the zip archive.

ExtractToDirectory(ZipArchive, String)

Extrait tous les fichiers dans l'archive zip d'un répertoire sur le système de fichiers.Extracts all the files in the zip archive to a directory on the file system.

ExtractToDirectory(ZipArchive, String, Boolean)

Extrait tous les fichiers de l’archive dans un répertoire du système de fichiers.Extracts all of the files in the archive to a directory on the file system.

S’applique à

Voir aussi