FTPS

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

Copie un fichier vers ou depuis un serveur FTP utilisant FTPS.

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

Mode

Mnémonique

Syntaxe
1 DOWNLOAD 1
2 UPLOAD 2

Arguments communs

Argument

Description
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.
FtpSecure

Numérique indiquant le type de connexion FTPS. Par défaut : 0.

  • 0 : Explicite.
  • 1 : Implicite.

Type INTEGER.
FtpTls

Numérique indiquant la version de TLS à utiliser. Par défaut : 2.

  • 0 : Tls 1.0
  • 1 : Tls 1.1
  • 2 : Tls 1.2

Type INTEGER.

Syntaxe 1

FTPS("DOWNLOAD", FtpsFileSource, FileDestination [, HMIdisplay [, UserName, Password [, VariableName [, FtpSecure] [, FtpTls]]]]);

Type de retour : INTEGER.

Argument

Description
FtpsFileSource Chemin complet du fichier à télécharger, par exemple "ftps://server/path”. Type STR.
FileDestination Chemin de destination locale pour stocker le fichier. Il peut être absolu ou relatif au dossier TP du projet. 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.
  • -6 : La valeur du paramètre FtpSecure est incorrecte.
  • -7 : La valeur du paramètre FtpTls est incorrecte.
  • -8 : La connexion est occupée.

Syntaxe 2

FTPS("UPLOAD", FileSource, FtpsFileDestination [, HMIdisplay [, UserName, Password [, VariableName [, FtpSecure] [, FtpTls]]]]);

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. Type STR.
FtpsFileDestination 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.
  • -6 : La valeur du paramètre FtpSecure est incorrecte.
  • -7 : La valeur du paramètre FtpsTls est incorrecte.
  • -8 : La connexion est occupée.

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'IHM 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.