My.Computer.Network.DownloadFile (Método)

Actualización: noviembre 2007

Descarga el archivo remoto especificado y lo guarda en la ubicación especificada.

' Usage
My.Computer.Network.DownloadFile(address ,destinationFileName)
My.Computer.Network.DownloadFile(address ,destinationFileName)
My.Computer.Network.DownloadFile(address ,destinationFileName ,userName ,password)
My.Computer.Network.DownloadFile(address ,destinationFileName ,userName ,password)
My.Computer.Network.DownloadFile(address ,destinationFileName ,userName ,password ,showUI ,connectionTimeout ,overwrite)
My.Computer.Network.DownloadFile(address ,destinationFileName ,userName ,password ,showUI ,connectionTimeout ,overwrite ,onUserCancel)
My.Computer.Network.DownloadFile(address ,destinationFileName ,userName ,password ,showUI ,connectionTimeout ,overwrite)
My.Computer.Network.DownloadFile(address ,destinationFileName ,userName ,password ,showUI ,connectionTimeout ,overwrite ,onUserCancel)
My.Computer.Network.DownloadFile(address ,destinationFileName ,networkCredentials ,showUI ,connectionTimeout ,overwrite)
My.Computer.Network.DownloadFile(address ,destinationFileName ,networkCredentials ,showUI ,connectionTimeout ,overwrite ,onUserCancel)
' Declaration
Public Sub DownloadFile( _
   ByVal address As String, _
   ByVal destinationFileName As String _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As System.Uri, _
   ByVal destinationFileName As String _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As String, _
   ByVal destinationFileName As String, _
   ByVal userName As String, _
   ByVal password As String _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As System.Uri, _
   ByVal destinationFileName As String, _
   ByVal userName As String, _
   ByVal password As String _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As String, _
   ByVal destinationFileName As String, _
   ByVal userName As String, _
   ByVal password As String, _
   ByVal showUI As Boolean, _
   ByVal connectionTimeout As Integer, _
   ByVal overwrite As Boolean _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As String, _
   ByVal destinationFileName As String, _
   ByVal userName As String, _
   ByVal password As String, _
   ByVal showUI As Boolean, _
   ByVal connectionTimeout As Integer, _
   ByVal overwrite As Boolean, _
   ByVal onUserCancel As UICancelOption _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As System.Uri, _
   ByVal destinationFileName As String, _
   ByVal userName As String, _
   ByVal password As String, _
   ByVal showUI As Boolean, _
   ByVal connectionTimeout As Integer, _
   ByVal overwrite As Boolean _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As System.Uri, _
   ByVal destinationFileName As String, _
   ByVal userName As String, _
   ByVal password As String, _
   ByVal showUI As Boolean, _
   ByVal connectionTimeout As Integer, _
   ByVal overwrite As Boolean, _
   ByVal onUserCancel As UICancelOption _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As System.Uri, _
   ByVal destinationFileName As String, _
   ByVal networkCredentials As System.Net.ICredentials, _
   ByVal showUI As Boolean, _
   ByVal connectionTimeout As Integer, _
   ByVal overwrite As Boolean _
)
' -or-
Public Sub DownloadFile( _
   ByVal address As System.Uri, _
   ByVal destinationFileName As String, _
   ByVal networkCredentials As System.Net.ICredentials, _
   ByVal showUI As Boolean, _
   ByVal connectionTimeout As Integer, _
   ByVal overwrite As Boolean, _
   ByVal onUserCancel As UICancelOption _
)

Parámetros

• address
  String o Uri Ruta de acceso del archivo que se va a descargar, incluidos el nombre de archivo y la dirección del host. Obligatorio.

• destinationFileName
  String. Nombre de archivo y ruta de acceso del archivo descargado. Obligatorio.

• userName
  String. Nombre de usuario que se va a autenticar. El valor predeterminado es una cadena vacía, "".

• password
  String.Contraseña que se va a autenticar. El valor predeterminado es una cadena vacía, "".

• showUI
  Boolean. Especifica si se va a mostrar el progreso de la operación. El valor predeterminado es False.

• connectionTimeout
  Int32. Intervalo de tiempo de espera en milisegundos. El valor predeterminado es 100 segundos.

• overwrite
  Boolean. Especifica si se van a sobrescribir los archivos existentes. El valor predeterminado es False.

• onUserCancel
  UICancelOption. Especifica el comportamiento cuando el usuario hace clic en Cancelar o en No en el cuadro de diálogo mostrado como resultado de ShowUI establecido en True. El valor predeterminado es ThrowException.

• networkCredentials
  ICredentials. Credenciales que se van a proporcionar.

Excepciones

Las condiciones siguientes pueden provocar que se produzca una excepción:

• El nombre de la unidad no es válido (ArgumentException).

• destinationFileName finaliza con una barra oblicua final (ArgumentException).

• overwrite está establecido en False y el archivo de destino existe (IOException).

• El servidor no responde dentro del valor de connectionTimeout especificado (TimeoutException).

• Se produce un error en la autenticación (SecurityException).

• El usuario no tiene los permisos necesarios (SecurityException).

• El sitio Web deniega la solicitud (WebException).

Comentarios

Si showUI se establece en True, aparece un cuadro de diálogo que muestra el progreso de la operación; en él se incluye un botón Cancelar que se puede utilizar para cancelar la operación. El cuadro de diálogo no es modal y por tanto no bloquea la entrada del usuario en otras ventanas del programa.

Si el servidor no responde dentro del intervalo especificado en connectionTimeout, se cancela la operación y se produce una excepción.

DownloadFile envía la información de traza al habilitar el seguimiento de la red en su aplicación. Para obtener más información, vea Enabling Network Tracing.

Nota:
El método DownloadFile no envía encabezados HTTP opcionales. Algunos servidores pueden devolver 500 (Error interno del servidor) si se produce un error en el encabezado de agente de usuario opcional. Para enviar encabezados opcionales, debe crear una solicitud mediante la clase WebClient. Para obtener más información, vea Operaciones de red en .NET Framework con Visual Basic.

Nota de seguridad:
El protocolo FTP envía información, incluidas las contraseñas, en texto sin formato y no se debe utilizar para transmitir información confidencial.

Tareas

En la tabla siguiente se enumera un ejemplo de una tarea en la que interviene el método My.Computer.Network.DownloadFile.

Para	Vea
Descargar un archivo	Cómo: Descargar un archivo en Visual Basic

Ejemplo

En este ejemplo se descarga el archivo WineList.txt desde http://www.cohowinery.com/downloads y se guarda en C:\Documents and Settings\All Users\Documents.

My.Computer.Network.DownloadFile _
("http://www.cohowinery.com/downloads/WineList.txt", _
"C:\Documents and Settings\All Users\Documents\WineList.txt")

Este ejemplo descarga el archivo WineList.txt de http://www.cohowinery.com/downloads y lo guarda en C:\Documents and Settings\All Users\Documents, especificando un intervalo de tiempo de espera de 500 milisegundos.

My.Computer.Network.DownloadFile _
("http://www.cohowinery.com/downloads/", _
"C:\Documents and Settings\All Users\Documents\WineList.txt", _
"", "", False, 500, True)

Requisitos

Espacio de nombres:Microsoft.VisualBasic.Devices

Clase:Network

Ensamblado: biblioteca en tiempo de ejecución de Visual Basic (en Microsoft.VisualBasic.dll)

Disponibilidad por tipo de proyecto

Tipo de proyecto	Disponible
Aplicación para Windows	Sí
Biblioteca de clases	Sí
Aplicación de consola	Sí
Biblioteca de controles de Windows	Sí
Biblioteca de controles Web	Sí
Servicio de Windows	Sí
Sitio Web	Sí

Permisos

Los permisos siguientes pueden ser necesarios:

Permiso	Descripción
FileIOPermission	Controla la capacidad de tener acceso a archivos y carpetas. Enumeración asociada: Unrestricted.
UIPermission	Controla los permisos relacionados con interfaces de usuario y el Portapapeles. Enumeración asociada: AllWindows.
WebPermission	Controla los derechos para obtener acceso a los recursos de Internet HTTP. Enumeración asociada: Unrestricted.

Para obtener más información, vea Seguridad de acceso a código y Solicitar permisos.

Vea también

Tareas

Cómo: Descargar un archivo en Visual Basic

Cómo: Determinar si un equipo remoto está disponible en Visual Basic

Cómo: Analizar rutas de acceso a archivos en Visual Basic

Referencia

My.Computer.Network (Objeto)

System.Uri

System.Net.ICredentials

Network.DownloadFile