ZipFile.CreateFromDirectoryAsync Método

Origem:

ZipFile.Create.Async.cs

Origem:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

Devoluções

Exceções

Observações

A estrutura de diretórios do sistema de ficheiros é preservada no arquivo. Se o diretório estiver vazio, cria-se um arquivo vazio.

Esta sobrecarga de métodos não inclui o diretório base no arquivo e não permite especificar um nível de compressão.

Se quiseres incluir o diretório base ou especificar um nível de compressão, chama o CreateFromDirectory(String, Stream, CompressionLevel, Boolean) método overload.

Se um ficheiro no diretório não puder ser adicionado ao arquivo, o arquivo fica incompleto e inválido, e o método lança uma IOException exceção.

Origem:

ZipFile.Create.Async.cs

Origem:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

Devoluções

Exceções

Observações

A estrutura de diretórios é preservada no arquivo, e é feita uma pesquisa recursiva para os ficheiros a arquivar. O arquivo não pode existir. Se o diretório estiver vazio, cria-se um arquivo vazio. Se um ficheiro no diretório não puder ser adicionado ao arquivo, o arquivo ficará incompleto e inválido e o método lançará uma exceção. Este método não inclui o diretório base no arquivo.

Se for encontrado um erro ao adicionar ficheiros ao arquivo, este método deixa de adicionar ficheiros e deixa o arquivo num estado inválido. Os caminhos podem especificar informação relativa ou absoluta do caminho. A informação relativa do caminho é interpretada como relativa ao diretório de trabalho atual. Se um ficheiro no arquivo tiver dados no campo do último tempo de escrita que não sejam um carimbo temporal zip válido, será usado um valor indicador de 1 de janeiro de 1980 à meia-noite para a última hora modificada do ficheiro. Se já existir uma entrada com o nome especificado no arquivo, é criada uma segunda entrada com um nome idêntico. Como não CompressionLevel é especificado, o padrão fornecido pela implementação do algoritmo de compressão subjacente é usado; o ZipArchive não impõe o seu próprio padrão.

(Atualmente, o algoritmo de compressão subjacente é fornecido pela DeflateStream classe.)

Origem:

ZipFile.Create.Async.cs

Origem:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

Devoluções

Exceções

Observações

A estrutura de diretórios do sistema de ficheiros é preservada no arquivo. Se o diretório estiver vazio, cria-se um arquivo vazio.

Use esta sobrecarga de métodos para especificar o nível de compressão e se deve incluir o diretório base no arquivo.

Se um ficheiro no diretório não puder ser adicionado ao arquivo, o arquivo fica incompleto e inválido, e o método lança uma IOException exceção.

Origem:

ZipFile.Create.Async.cs

Origem:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * string * System.IO.Compression.CompressionLevel * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

Devoluções

Exceções

Observações

A estrutura de diretórios é preservada no arquivo, e é feita uma pesquisa recursiva para os ficheiros a arquivar. O arquivo não pode existir. Se o diretório estiver vazio, será criado um arquivo vazio.

Se um ficheiro no diretório não puder ser adicionado ao arquivo, o arquivo ficará incompleto e inválido e o método lançará uma exceção. Este método inclui opcionalmente o diretório base no arquivo.

Se surgir um erro ao adicionar ficheiros ao arquivo, este método deixará de adicionar ficheiros e deixará o arquivo num estado inválido. Os caminhos podem especificar informação relativa ou absoluta do caminho. A informação relativa do caminho é interpretada como relativa ao diretório de trabalho atual. Se um ficheiro no arquivo tiver dados no campo do último tempo de escrita que não sejam um carimbo temporal zip válido, será usado um valor indicador de 1 de janeiro de 1980 à meia-noite para a última hora modificada do ficheiro. Se uma entrada com o nome especificado já existir no arquivo, será criada uma segunda entrada com um nome idêntico. Como não CompressionLevel é especificado, será usado o padrão fornecido pela implementação do algoritmo de compressão subjacente; o ZipArchive não irá impor o seu próprio padrão.

(Atualmente, o algoritmo de compressão subjacente é fornecido pela DeflateStream classe.)

Origem:

ZipFile.Create.Async.cs

Origem:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

Devoluções

Exceções

Observações

A estrutura de diretórios do sistema de ficheiros é preservada no arquivo. Se o diretório estiver vazio, cria-se um arquivo vazio.

Use este método de sobrecarga para especificar o nível de compressão e a codificação de caracteres, e se deve incluir o diretório base no arquivo.

Se um ficheiro no diretório não puder ser adicionado ao arquivo, o arquivo fica incompleto e inválido, e o método lança uma IOException exceção.

Origem:

ZipFile.Create.Async.cs

Origem:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * string * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

Devoluções

Exceções

Observações

A estrutura de diretórios é preservada no arquivo, e é feita uma pesquisa recursiva para os ficheiros a arquivar. O arquivo não pode existir. Se o diretório estiver vazio, será criado um arquivo vazio.

Se um ficheiro no diretório não puder ser adicionado ao arquivo, o arquivo ficará incompleto e inválido e o método lançará uma exceção. Este método inclui opcionalmente o diretório base no arquivo.

Se surgir um erro ao adicionar ficheiros ao arquivo, este método deixará de adicionar ficheiros e deixará o arquivo num estado inválido. Os caminhos podem especificar informação relativa ou absoluta do caminho. A informação relativa do caminho é interpretada como relativa ao diretório de trabalho atual. Se um ficheiro no arquivo tiver dados no campo do último tempo de escrita que não sejam um carimbo temporal zip válido, será usado um valor indicador de 1 de janeiro de 1980 à meia-noite para a última hora modificada do ficheiro. Se uma entrada com o nome especificado já existir no arquivo, será criada uma segunda entrada com um nome idêntico. Como não CompressionLevel é especificado, será usado o padrão fornecido pela implementação do algoritmo de compressão subjacente; o ZipArchive não irá impor o seu próprio padrão.

(Atualmente, o algoritmo de compressão subjacente é fornecido pela DeflateStream classe.)

Especificar um valor para entryNameEncoding outro que null não é desencorajado.

No entanto, isto pode ser necessário para a interoperabilidade com ferramentas e bibliotecas de arquivo zip que não suportam corretamente a codificação UTF-8 para nomes de entradas ou comentários.

• Se entryNameEncoding não for especificado (== null):
  • Para nomes de ficheiros ou comentários que contenham caracteres fora do intervalo ASCII:
    O flag de codificação da linguagem (EFS) será definido no flag de bit de uso geral do cabeçalho local do ficheiro da entrada correspondente, e o UTF-8 (Encoding.UTF8) será usado para codificar o nome da entrada e o comentário em bytes.
  • Para nomes de ficheiros ou comentários que não contenham caracteres fora do intervalo ASCII:
    O flag de codificação da linguagem (EFS) não será definido no flag de bit de uso geral do cabeçalho local do ficheiro da entrada correspondente, e a página de códigos padrão do sistema atual (Encoding.Default) será usada para codificar os nomes das entradas e comentários em bytes.
• Se entryNameEncoding for especificado (!= null):
  • O especificado entryNameEncoding será sempre usado para codificar os nomes das entradas e comentários em bytes.
    O flag de codificação da linguagem (EFS) no flag de bit de uso geral do cabeçalho local do ficheiro para cada entrada será definido se e só se o especificado entryNameEncoding for uma codificação UTF-8.

Codificações Unicode que não sejam UTF-8 não podem ser usadas para o entryNameEncoding, caso contrário um ArgumentException é lançado.