WebClient.DownloadFileAsync Método

Definição

Namespace:

System.Net

Assembly:

System.Net.WebClient.dll

Baixa o recurso especificado para um arquivo local como uma operação assíncrona. Esses métodos não bloqueiam o thread de chamada.

Sobrecargas

DownloadFileAsync(Uri, String)	Baixa o recurso com o URI especificado em um arquivo local. Esse método não bloqueia o thread de chamada.
DownloadFileAsync(Uri, String, Object)	Baixa o recurso com o URI especificado em um arquivo local. Esse método não bloqueia o thread de chamada.

DownloadFileAsync(Uri, String)

Origem:

WebClient.cs

Baixa o recurso com o URI especificado em um arquivo local. Esse método não bloqueia o thread de chamada.

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName);

public void DownloadFileAsync (Uri address, string fileName);

member this.DownloadFileAsync : Uri * string -> unit

Public Sub DownloadFileAsync (address As Uri, fileName As String)

Parâmetros

address

Uri

O URI do recurso a ser baixado.

fileName

String

O nome do arquivo a ser colocado no computador local.

Exceções

ArgumentNullException

O parâmetro address é null.

- ou -

O parâmetro fileName é null.

WebException

O URI formado pela combinação de BaseAddress e address é inválido.

- ou -

Ocorreu um erro ao baixar o recurso.

InvalidOperationException

O arquivo local especificado pelo fileName está em uso por outro thread.

Comentários

Esse método baixa o recurso no URI especificado por no address parâmetro . Quando o download for concluído com êxito, o arquivo baixado será nomeado fileName no computador local. O arquivo é baixado de forma assíncrona usando recursos de thread que são alocados automaticamente do pool de threads. Para receber uma notificação quando o arquivo estiver disponível, adicione um manipulador de eventos ao DownloadFileCompleted evento.

Esse método não bloqueia o thread de chamada enquanto o recurso está sendo baixado. Para bloquear enquanto aguarda a conclusão do download, use um dos DownloadFile métodos .

No .NET Framework e no .NET Core 1.0, você pode cancelar operações assíncronas que não foram concluídas chamando o CancelAsync método .

Se a BaseAddress propriedade não for uma cadeia de caracteres vazia ("") e address não especificar um URI absoluto, address deverá ser um URI relativo combinado com BaseAddress para formar o URI absoluto dos dados solicitados. Se a QueryString propriedade não for uma cadeia de caracteres vazia, ela será acrescentada a address.

Esse método usa o comando RETR para baixar um recurso FTP. Para um recurso HTTP, o método GET é usado.

Observação

Esse membro emite o rastreamento de informações quando você ativa o rastreamento de rede em seu aplicativo. Para obter mais informações, consulte Rastreamento de rede em .NET Framework.

Ao usar esse método em uma página ASP.NET, você receberá um erro se a conta em que a página é executada não tiver permissão para acessar o arquivo local.

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por DownloadFile(Uri, String).

DownloadFileAsync(Uri, String, Object)

Origem:

WebClient.cs

Baixa o recurso com o URI especificado em um arquivo local. Esse método não bloqueia o thread de chamada.

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName, System::Object ^ userToken);

public void DownloadFileAsync (Uri address, string fileName, object? userToken);

member this.DownloadFileAsync : Uri * string * obj -> unit

Public Sub DownloadFileAsync (address As Uri, fileName As String, userToken As Object)

Parâmetros

address

Uri

O URI do recurso a ser baixado.

fileName

String

O nome do arquivo a ser colocado no computador local.

userToken

Object

Um objeto definido pelo usuário passado para o método invocado quando a operação assíncrona é concluída.

Exceções

ArgumentNullException

O parâmetro address é null.

- ou -

O parâmetro fileName é null.

WebException

O URI formado pela combinação de BaseAddress e address é inválido.

- ou -

Ocorreu um erro ao baixar o recurso.

InvalidOperationException

O arquivo local especificado pelo fileName está em uso por outro thread.

Comentários

Esse método baixa o recurso no URI especificado por no address parâmetro . Quando o download for concluído com êxito, o arquivo baixado será nomeado fileName no computador local. O arquivo é baixado de forma assíncrona usando recursos de thread que são alocados automaticamente do pool de threads. Para receber uma notificação quando o arquivo estiver disponível, adicione um manipulador de eventos ao DownloadFileCompleted evento.

Esse método não bloqueia o thread de chamada enquanto o recurso está sendo baixado. Para bloquear enquanto aguarda a conclusão do download, use um dos DownloadFile métodos .

No .NET Framework e no .NET Core 1.0, você pode cancelar operações assíncronas que não foram concluídas chamando o CancelAsync método .

Se a BaseAddress propriedade não for uma cadeia de caracteres vazia ("") e address não especificar um URI absoluto, address deverá ser um URI relativo combinado com BaseAddress para formar o URI absoluto dos dados solicitados. Se a QueryString propriedade não for uma cadeia de caracteres vazia, ela será acrescentada a address.

Esse método usa o comando RETR para baixar um recurso FTP. Para um recurso HTTP, o método GET é usado.

Observação

Esse membro emite o rastreamento de informações quando você ativa o rastreamento de rede em seu aplicativo. Para obter mais informações, consulte Rastreamento de rede em .NET Framework.

Ao usar esse método em uma página ASP.NET, você receberá um erro se a conta em que a página é executada não tiver permissão para acessar o arquivo local.