FTP

Icône du lien vers le conceptVoir également Icône du lien vers le conceptExemple

Copie un fichier vers ou depuis un serveur FTP.

Support WebVue - Oui. L'IHM en exploitation n'est pas supportée.

Mode

Mnémonique

Syntaxe
1 DOWNLOAD 1
2 UPLOAD 2

Par conception, le protocole FTP est considéré comme un faible car il transmet des données en texte clair sur un réseau TCP/IP. Il est obsolète et ne doit plus être utilisé. Utilisez des connexions FTPS et l'instruction FTPS à la place.

Arguments communs

Argument

Définition
HMIdisplay

Affichage de la barre de progression sur un client lourd :

  • 0 : Aucune.
  • 1 : Boîte de dialogue sans bouton Annuler (par défaut).
  • 2 : Boîte de dialogue avec bouton Annuler.

Type : INTEGER.
UserName

Nom de l'utilisateur du compte utilisé pour la connexion au serveur FTP. Si omis, une tentative de connexion anonyme est effectuée. Type STR.
Password

Mot de passe du compte utilisé pour la connexion au serveur FTP. Type STR.

Syntaxe 1

FTP("DOWNLOAD", FtpFileSource, FileDestination [, HMIdisplay [, UserName, Password [, VariableName]]]);

Type de retour : INTEGER.

Argument

Description

FtpFileSource

Chemin complet du fichier à télécharger, par exemple "ftp://server/path”. Type STR.
FileDestination

Chemin de destination locale pour stocker le fichier. Il peut être absolu ou relatif au dossier TP du projet, mais pas le chemin d'un site FTP. Type STR.
VariableName

Nom d'une variable mesure utilisée pour fournir une indication de status :

  • 0 : Transfert en cours.
  • 1 : Terminé
  • 2 : Annulé par l'utilisateur.
  • 3 : Le nom du serveur distant ne peut pas être trouvé.
  • 4 : Échec d'authentification.
  • 5 : Le fichier source à télécharger n'existe pas.
  • 6 : Connecté mais permission refusée.
  • 7 : Transfert annulé - Une erreur est survenue.

Type STR.

Si la variable n'existe pas, le transfert peut s'effectuer, mais aucun status ne peut être surveillé. Un message d'information s'affichera dans l'observateur d'événement.

Exécution

Mode

Mnémonique

Action

1

DOWNLOAD

Copie un fichier depuis un serveur FTP vers une destination locale.

Retour :

  • 0 : Aucune erreur.
  • -1 : Le premier argument est manquant.
  • -2 : Le deuxième argument est manquant.
  • -3 : Le troisième argument est hors plage.
  • -4 : Mode inconnu.
  • -5 : HMIDisplay est différent de 0 et l'IHM pour le transfert de fichier n'est pas supportée dans le contexte d'exécution.

Syntaxe 2

FTP("UPLOAD", FileSource, FtpFileDestination [, HMIdisplay [, UserName, Password [, VariableName]]]);

Type de retour : INTEGER.

Argument

Description

FileSource

Chemin complet du fichier à téléverser. Il peut être absolu ou relatif au dossier TP du projet, mais pas le chemin d'un site FTP. Type STR.
FtpFileDestination

Chemin du FTP de destination. Type STR.
VariableName

Nom d'une variable mesure utilisée pour fournir une indication de status :

  • 0 : Transfert en cours.
  • 1 : Terminé
  • 2 : Annulé par l'utilisateur.
  • 3 : Le nom du serveur distant ne peut pas être trouvé.
  • 4 : Échec d'authentification.
  • 5 : Le fichier source à téléverser n'existe pas.
  • 6 : Connecté mais permission refusée.
  • 7 : Transfert annulé - Une erreur est survenue.

Type STR.

Si la variable n'existe pas, le transfert peut s'effectuer, mais aucun status ne peut être surveillé. Un message d'information s'affichera dans l'observateur d'événement.

Exécution

Mode

Mnémonique

Action

1

UPLOAD

Copie un fichier stocké localement vers un serveur FTP.

Retour :

  • 0 : Aucune erreur.
  • -1 : Le premier argument est manquant.
  • -2 : Le deuxième argument est manquant.
  • -3 : Le troisième argument est hors plage.
  • -4 : Mode inconnu.
  • -5 : HMIDisplay est différent de 0 et l'IHM pour le transfert de fichier n'est pas supportée dans le contexte d'exécution.

L'IHM pour le transfert de fichiers

Durant le transfert, une boîte de dialogue s'affiche en option avec les deux chemins, la vitesse de transfert des données et une barre de progression. FerméVoir l'image

L'interface utilisateur pour le transfert de fichier n'est pas supportée par WebVue. En conséquence de quoi l'argument HMIDisplay doit être 0 pour que l'instruction s'exécute en contexte WebVue. Une erreur est retournée et l'instruction ne s'exécute pas en contexte WebVue si une autre valeur est passée.

Exemple

Pour un exemple, cliquez sur le lien Exemple en haut de cette rubrique.