WebClient.DownloadFileAsync Método

Definición

Espacio de nombres:

System.Net

Ensamblado:

System.Net.WebClient.dll

Descarga el recurso especificado en un archivo local como una operación asincrónica. Estos métodos no bloquean el subproceso que realiza la llamada.

Sobrecargas

DownloadFileAsync(Uri, String)	Descarga en un archivo local el recurso con el URI especificado. Este método no bloquea el subproceso que realiza la llamada.
DownloadFileAsync(Uri, String, Object)	Descarga en un archivo local el recurso con el URI especificado. Este método no bloquea el subproceso que realiza la llamada.

DownloadFileAsync(Uri, String)

Source:

WebClient.cs

Descarga en un archivo local el recurso con el URI especificado. Este método no bloquea el subproceso que realiza la llamada.

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

URI del recurso que se va a descargar.

fileName

String

Nombre del archivo que se va a colocar en el equipo local.

Excepciones

ArgumentNullException

El parámetro address es null.

o bien

El parámetro fileName es null.

WebException

El identificador URI formado al combinar BaseAddress y address no es válido.

o bien

Se ha producido un error al descargar el recurso.

InvalidOperationException

Otro subproceso está usando el archivo local especificado por fileName.

Comentarios

Este método descarga el recurso en el URI especificado por en el address parámetro . Cuando la descarga se completa correctamente, el archivo descargado se denomina fileName en el equipo local. El archivo se descarga de forma asincrónica mediante recursos de subprocesos que se asignan automáticamente desde el grupo de subprocesos. Para recibir una notificación cuando el archivo esté disponible, agregue un controlador de eventos al DownloadFileCompleted evento.

Este método no bloquea el subproceso que realiza la llamada mientras se descarga el recurso. Para bloquear mientras espera a que se complete la descarga, use uno de los DownloadFile métodos .

En .NET Framework y .NET Core 1.0, puede cancelar las operaciones asincrónicas que no se han completado llamando al CancelAsync método .

Si la BaseAddress propiedad no es una cadena vacía ("") y address no especifica un URI absoluto, address debe ser un URI relativo combinado con BaseAddress para formar el URI absoluto de los datos solicitados. Si la QueryString propiedad no es una cadena vacía, se anexa a address.

Este método usa el comando RETR para descargar un recurso FTP. Para un recurso HTTP, se usa el método GET.

Nota

Este miembro genera información de seguimiento cuando se habilita el seguimiento de red en la aplicación. Para obtener más información, vea Seguimiento de red en .NET Framework.

Al usar este método en una página de ASP.NET, recibirá un error si la cuenta en la que se ejecuta la página no tiene permiso para acceder al archivo local.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por DownloadFile(Uri, String).

DownloadFileAsync(Uri, String, Object)

Source:

WebClient.cs

Descarga en un archivo local el recurso con el URI especificado. Este método no bloquea el subproceso que realiza la llamada.

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

URI del recurso que se va a descargar.

fileName

String

Nombre del archivo que se va a colocar en el equipo local.

userToken

Object

Objeto definido por el usuario que se pasa al método invocado cuando se completa la operación asincrónica.

Excepciones

ArgumentNullException

El parámetro address es null.

o bien

El parámetro fileName es null.

WebException

El identificador URI formado al combinar BaseAddress y address no es válido.

o bien

Se ha producido un error al descargar el recurso.

InvalidOperationException

Otro subproceso está usando el archivo local especificado por fileName.

Comentarios

Este método descarga el recurso en el URI especificado por en el address parámetro . Cuando la descarga se completa correctamente, el archivo descargado se denomina fileName en el equipo local. El archivo se descarga de forma asincrónica mediante recursos de subprocesos que se asignan automáticamente desde el grupo de subprocesos. Para recibir una notificación cuando el archivo esté disponible, agregue un controlador de eventos al DownloadFileCompleted evento.

Este método no bloquea el subproceso que realiza la llamada mientras se descarga el recurso. Para bloquear mientras espera a que se complete la descarga, use uno de los DownloadFile métodos .

En .NET Framework y .NET Core 1.0, puede cancelar las operaciones asincrónicas que no se han completado llamando al CancelAsync método .

Si la BaseAddress propiedad no es una cadena vacía ("") y address no especifica un URI absoluto, address debe ser un URI relativo combinado con BaseAddress para formar el URI absoluto de los datos solicitados. Si la QueryString propiedad no es una cadena vacía, se anexa a address.

Este método usa el comando RETR para descargar un recurso FTP. Para un recurso HTTP, se usa el método GET.

Nota

Este miembro genera información de seguimiento cuando se habilita el seguimiento de red en la aplicación. Para obtener más información, vea Seguimiento de red en .NET Framework.

Al usar este método en una página de ASP.NET, recibirá un error si la cuenta en la que se ejecuta la página no tiene permiso para acceder al archivo local.