My.Computer.Network.DownloadFile, méthode

Mise à jour : novembre 2007

Télécharge le fichier distant spécifié et l'enregistre à l'emplacement spécifié.

' 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 _
)

Paramètres

• address
  String ou Uri. Chemin d'accès au fichier à télécharger, y compris nom de fichier et adresse d'hôte. Obligatoire.

• destinationFileName
  String. Chemin d'accès et nom du fichier téléchargé. Obligatoire.

• userName
  String. Nom d'utilisateur pour authentification. La valeur par défaut est une chaîne vide, "".

• password
  String. Mot de passe pour authentification. La valeur par défaut est une chaîne vide, "".

• showUI
  Boolean. Spécifie si besoin d'afficher l'avancement de l'opération. La valeur par défaut est False.

• connectionTimeout
  Int32. Intervalle de délai en millisecondes. La valeur par défaut est de 100 secondes.

• overwrite
  Boolean. Spécifie si besoin de remplacer des fichiers existants. La valeur par défaut est False.

• onUserCancel
  UICancelOption. Spécifie le comportement lorsque l'utilisateur clique sur Annuler ou sur Non dans la boîte de dialogue qui s'affiche lorsque ShowUI a la valeur True. La valeur par défaut est ThrowException.

• networkCredentials
  ICredentials. Informations d'identification à fournir.

Exceptions

Les conditions ci-dessous peuvent lever une exception :

• Le nom du lecteur n'est pas valide (ArgumentException).

• destinationFileName se termine par une barre oblique finale (ArgumentException).

• overwrite a la valeur False et le fichier de destination existe déjà (IOException).

• Le serveur ne répond pas dans l'intervalle connectionTimeout spécifié (TimeoutException).

• L'authentification a échoué (SecurityException).

• L'utilisateur n'a pas les autorisations nécessaires (SecurityException).

• La demande est refusée par le site Web (WebException).

Notes

Si showUI a la valeur True, une boîte de dialogue s'affiche en indiquant l'avancement de l'opération ; elle comporte un bouton Annuler que l'utilisateur peut utiliser pour annuler l'opération. Cette boîte de dialogue n'étant pas modale, elle ne bloque pas les entrées d'utilisateur dans les autres fenêtres du programme.

Si le serveur ne répond pas dans l'intervalle connectionTimeout spécifié, l'opération est annulée et une exception est levée.

DownloadFile génère des informations de traçage lorsque vous activez le traçage réseau dans votre application. Pour plus d'informations, consultez Enabling Network Tracing.

Remarque :

La méthode DownloadFile n'envoie pas d'en-têtes HTTP facultatifs. Certains serveurs peuvent retourner 500 (Erreur interne du serveur) en cas d'absence de l'en-tête d'agent utilisateur (user agent) facultatif. Pour envoyer des en-têtes facultatifs, vous devez créer une demande à l'aide de la classe WebClient. Pour plus d'informations, consultez Opérations de réseau dans le .NET Framework avec Visual Basic.

Note de sécurité :
Le protocole FTP envoie les informations, y compris les mots de passe, en texte brut, et ne doit pas être utilisé pour transmettre des informations sensibles.

Tâches

Le tableau suivant présente un exemple de tâche impliquant la méthode My.Computer.Network.DownloadFile.

Exemple

Cet exemple télécharge le fichier WineList.txt à partir de http://www.cohowinery.com/downloads et l'enregistre dans 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")

Cet exemple télécharge le fichier WineList.txt à partir de http://www.cohowinery.com/downloads et l'enregistre dans C:\Documents and Settings\All Users\Documents, en spécifiant un intervalle de délai d'attente de 500 millisecondes.

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

Configuration requise

Espace de noms :Microsoft.VisualBasic.Devices

Classe :Network

Assembly : bibliothèque runtime Visual Basic (dans Microsoft.VisualBasic.dll)

Disponibilité par type de projet

Autorisations

Les autorisations suivantes peuvent être nécessaires :

Pour plus d'informations, consultez Sécurité d'accès du code et Demande d'autorisations.

Voir aussi

Tâches

Comment : télécharger un fichier dans Visual Basic

Comment : déterminer si un ordinateur distant est disponible dans Visual Basic

Comment : analyser des chemins d'accès dans Visual Basic

Référence

My.Computer.Network, objet

System.Uri

System.Net.ICredentials

Network.DownloadFile