ZipArchive ZipArchive ZipArchive ZipArchive Class

Definición

Representa un paquete de archivos comprimidos en formato de archivo 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
Herencia
ZipArchiveZipArchiveZipArchiveZipArchive
Implementaciones

Ejemplos

El primer ejemplo muestra cómo crear una nueva entrada y escribir en él mediante el uso de una secuencia.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

El ejemplo siguiente muestra cómo abrir un archivo zip y recorrer en iteración la colección de entradas.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

El tercer ejemplo muestra cómo usar los métodos de extensión para crear una nueva entrada en un archivo zip desde un archivo existente y extraiga el contenido del archivo.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. Debe hacer referencia a la System.IO.Compression.FileSystem ensamblado para ejecutar el código.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

Comentarios

Los métodos para manipular archivos zip y sus entradas de archivo están repartidos entre tres clases: ZipFile, ZipArchive, y ZipArchiveEntry.The methods for manipulating zip archives and their file entries are spread across three classes: ZipFile, ZipArchive, and ZipArchiveEntry.

EnTo UsarUse
Crea un archivo zip desde un directorioCreate a zip archive from a directory ZipFile.CreateFromDirectory
Extraiga el contenido de un archivo zip en un directorioExtract the contents of a zip archive to a directory ZipFile.ExtractToDirectory
Agregar nuevos archivos a un archivo zip existentesAdd new files to an existing zip archive ZipArchive.CreateEntry
Recuperar un archivo de un archivo zipRetrieve a file from a zip archive ZipArchive.GetEntry
Recuperar todos los archivos de un archivo zipRetrieve all the files from a zip archive ZipArchive.Entries
Abrir una secuencia en un único archivo contenido en un archivo zipOpen a stream to a single file contained in a zip archive ZipArchiveEntry.Open
Eliminar un archivo de un archivo zipDelete a file from a zip archive ZipArchiveEntry.Delete

Cuando se crea una nueva entrada, el archivo se comprime y agregar al paquete zip.When you create a new entry, the file is compressed and added to the zip package. El CreateEntry método le permite especificar una jerarquía de directorios, al agregar la entrada.The CreateEntry method enables you to specify a directory hierarchy when adding the entry. Incluir la ruta de acceso relativa de la nueva entrada en el paquete zip.You include the relative path of the new entry within the zip package. Por ejemplo, crear una nueva entrada con una ruta de acceso relativa de AddedFolder\NewFile.txt crea un archivo de texto comprimido en un directorio denominado 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 se hace referencia el System.IO.Compression.FileSystem ensamblado en el proyecto, puede tener acceso a tres métodos de extensión (desde el ZipFileExtensions clase) para el ZipArchive clase: CreateEntryFromFile, CreateEntryFromFile, y ExtractToDirectory.If you reference the System.IO.Compression.FileSystem assembly in your project, you can access three extension methods (from the ZipFileExtensions class) for the ZipArchive class: CreateEntryFromFile, CreateEntryFromFile, and ExtractToDirectory. Estos métodos de extensión permiten comprimir y descomprimir el contenido de la entrada a un archivo.These extension methods enable you to compress and decompress the contents of the entry to a file. El System.IO.Compression.FileSystem ensamblado no está disponible para Tienda Windows 8.xWindows 8.x Store aplicaciones.The System.IO.Compression.FileSystem assembly is not available for Tienda Windows 8.xWindows 8.x Store apps. En Tienda Windows 8.xWindows 8.x Store aplicaciones, puede comprimir y descomprimir los archivos mediante el uso de la DeflateStream o GZipStream clase, o bien puede usar el Windows en tiempo de ejecuciónWindows Runtime tipos compresor y descompresor.In Tienda Windows 8.xWindows 8.x Store apps, you can compress and decompress files by using the DeflateStream or GZipStream class, or you can use the Windows en tiempo de ejecuciónWindows Runtime types Compressor and Decompressor.

Constructores

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

Inicializa una nueva instancia de la clase ZipArchive a partir de la secuencia especificada.Initializes a new instance of the ZipArchive class from the specified stream.

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

Inicializa una nueva instancia de la clase ZipArchive a partir de la secuencia especificada y con el modo especificado.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)

Inicializa una nueva instancia de la clase ZipArchive en el flujo especificado para el modo especificado y, opcionalmente, deja el flujo abierto.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)

Inicializa una nueva instancia de la clase ZipArchive en el flujo especificado para el modo especificado, usa la codificación especificada para los nombres de entrada y opcionalmente deja el flujo abierto.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.

Propiedades

Entries Entries Entries Entries

Obtiene la colección de entradas que están actualmente en el archivo zip.Gets the collection of entries that are currently in the zip archive.

Mode Mode Mode Mode

Obtiene un valor que describe el tipo de acción que el archivo zip puede realizar en las entradas.Gets a value that describes the type of action the zip archive can perform on entries.

Métodos

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

Crea una entrada vacía en el archivo zip con la ruta de acceso y el nombre de entrada especificados.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)

Crea una entrada vacía en el archivo zip con el nombre de entrada y el nivel de compresión especificados.Creates an empty entry that has the specified entry name and compression level in the zip archive.

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

Libera los recursos utilizados por la instancia actual de la clase ZipArchive.Releases the resources used by the current instance of the ZipArchive class.

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

Llamado por los métodos Dispose() y Finalize() para liberar los recursos no administrados utilizados por la instancia actual de la clase de ZipArchive, y termina opcionalmente de escribir el archivo y libera los recursos administrados.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)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

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

Recupera un contenedor para la entrada especificada en el archivo zip.Retrieves a wrapper for the specified entry in the zip archive.

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

Sirve como la función hash predeterminada.Serves as the default hash function.

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

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

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

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

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

Devuelve una cadena que representa el objeto actual.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)

Archiva un archivo comprimiéndolo y agregándolo al archivo 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)

Archiva un archivo comprimiéndolo mediante el nivel especificado de compresión y agregándolo al archivo 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)

Extrae todos los archivos del archivo ZIP en un directorio del sistema de archivos.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)

Se aplica a

Consulte también: