FILETRANSFER
Contrôle les services de transfert de fichiers pour les drivers d'acquisition de données.
Support WebVue - Oui.
| Mode | Mnémonique | Syntaxe |
| 1 | DOWNLOAD | 1 |
| 2 | DOWNLOAD_FOLDER | 2 |
| 3 | DELETE | 3 |
Le verbe FILETRANSFER est actuellement utilisé pour supporter les services de transfert de fichiers pour les équipements IEC 61850 et DNP3. Voir M61850 et MDNP3 pour plus d'informations.
Propriétés communes à plusieurs modes
|
Argument |
Définition |
| ComObj | Nom complet de l'objet de communication, tel qu'il est configuré dans l'Application Explorer, auquel le transfert de fichier s'applique. Par exemple Network01.Device01. Type STR |
| SourceFile | Nom d'un fichier dans l'équipement de terrain correspondant à l'objet de communication. Type STR. |
| DestinationFolder |
Le dossier de destination est le dossier TP du projet par défaut. Cela sera utilisé si le paramètre DestinationFolder est vide. Type STR. Vous pouvez également utiliser un chemin complet tel que "C: \\ MyFiles" ou un chemin relatif tel que ".. \\ .. \\ MyFiles". Si exécutée dans le contexte d'une session WebVue, cette instruction est traitée par le back end web, en conséquence de quoi le dossier de destination est sur la machine back end web. |
| CurrentPositionVar | Nom d'une variable mesure qui sera mise à jour régulièrement avec le nombre d'octets déjà téléchargés. Type STR. |
| MaxPositionVar | Nom d'une variable mesure représentant la taille totale du fichier. Type STR. |
| ResultVar |
Nom d'une variable mesure dans laquelle une valeur correspondant au résultat de l'instruction est placée. Voir le tableau ci-dessous pour les valeurs possibles et leur signification. Type STR. |
La syntaxe attendue pour l'argument SourceFile peut dépendre du modèle de l'équipement de terrain, par exemple MyFile.txt ou \MyFile.txt.
Une manière de vérifier la syntaxe attendue par un certain modèle d'équipement est d'utiliser le Helper Transfert de fichiers disponible dans l'Application Explorer. Lorsque l'on browse les fichiers d'un équipement connecté, le Helper affiche les noms de fichiers tels que transmis par l'équipement, et donc tel que l'on peut s'attendre à devoir passer l'argument SourceFile.
Syntaxe 1
IntVal = FILETRANSFER(Mode, ComObj, SourceFile, DestinationFolder [, ResultVar[, CurrentPositionVar[, MaxPositionVar]]]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
|
1 |
DOWNLOAD |
Télécharge tous les fichiers du dossier spécifié de l'équipement de terrain correspondant à l'objet de communication. Retour : 0 si OK. Une valeur négative est une erreur de paramètre, la valeur indiquant quel paramètre est incorrect. Par exemple -3 signifie que le paramètre 3 est incorrect. |
Syntaxe 2
IntVal = FILETRANSFER(Mode, Sub-mode, ComObj, SourceFolder, DestinationFolder[, ResultVar[, CurrentFileVar[, MaxFileVar[, CurrentPositionVar[, MaxPositionVar]]]]]);
Type de retour : INTEGER.
|
Argument |
Description |
| Sous-mode |
Définit le comportement de téléchargement pour l'appel. Type STR. Les valeurs possibles sont :
|
| SourceFolder | Nom d'un dossier dans l'équipement de terrain correspondant à l'objet de communication. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
|
2 |
DOWNLOAD_FOLDER |
Télécharge le fichier nommé depuis l'équipement de terrain correspondant à l'objet de communication. Retour : 0 si OK. Une valeur négative est une erreur de paramètre, la valeur indiquant quel paramètre est incorrect. Par exemple -3 signifie que le paramètre 3 est incorrect. |
Syntaxe 3
IntVal = FILETRANSFER(Mode, ComObj, SourceFile [, ResultVar]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
|
3 |
DELETE |
Supprime le fichier spécifié de l'équipement de terrain correspondant à l'objet de communication. Retour : 0 si OK. Une valeur négative est une erreur de paramètre, la valeur indiquant quel paramètre est incorrect. Par exemple -3 signifie que le paramètre 3 est incorrect. |
L'instruction FILETRANSFER fonctionne de manière asynchrone. C'est-à-dire qu'une fois qu'une demande a été générée, le script continue sans attendre la fin de la requête. Le paramètre ResultVar peut être utilisé pour surveiller l’état des requêtes.
Valeurs de la variable de status
La variable ResultVar peut prendre les valeurs suivantes.
| Valeur | Description |
| 0 | Opération terminée avec succès |
| -1 | L'opération a échoué, erreur inconnue |
| -2 | L'opération a échoué, erreur interne |
| -3 | Pas d'objet de communication |
| -4 | L'objet de communication n'est pas connecté |
| -5 | L'opération a échoué, requête non-supportée |
| -6 | L'opération a échoué, accès refusé |
| -7 | Le téléchargement n'a pas pu être initialisé |
| -8 | Le téléchargement a échoué |
| -9 | Le téléchargement n'a pas pu être initialisé |
| -10 | Le téléchargement a échoué, position invalide |
| -11 | La suppression de fichier a échoué |
| -12 | Le browsing a échoué |
| -13 | Le routage de message a échoué |
| -14 | Pas de serveur distant |
| -15 | Pas de transaction |
| -16 | Pas de serveur |
| -17 | La connexion est déjà fermée |
| -18 | Erreur protocole, contrôle de flux activé |
| -19 | Erreur protocole, services max atteint |
| -20 | Erreur protocole, aucune donnée n'a été lue |
| -21 | Erreur protocole, mémoire |
| -22 | Erreur protocole, paramètres |
| -23 | Erreur protocole, transaction incorrecte |
| -24 | Erreur protocole, connexion fermée |
| -25 | Erreur protocole, time-out |
| -26 | Erreur protocole, état de la connexion |
| -27 | Erreur protocole, application |
| -28 | Erreur protocole, paramètres |
| -29 | Erreur protocole, erreur confirmée |
| -30 | Erreur protocole, problème d'encodage |
| -31 | Nom de fichier ambigu |
| -32 | Le téléchargement a échoué, le fichier est occupé |
| -33 | Le téléchargement a échoué, erreur de syntaxe dans le nom de fichier |
| -34 | Le téléchargement a échoué, type de contenu invalide |
| -35 | Le téléchargement a échoué, accès au fichier refusé |
| -36 | Impossible d'accéder au fichier de destination |
| -37 | Le téléchargement a échoué, fichier introuvable. Peut apparaître si vous essayez de télécharger un fichier qui n'existe pas sur le serveur |
| -38 | Le téléchargement a échoué, nom de fichier dupliqué dans le système de fichiers |
| -39 | Le téléchargement a échoué, espace insuffisant sur le système de fichiers |
| -40 | Equipement non-démarré |
| -41 | Equipement en erreur |
| -42 | Erreur de browsing, pas de fichier ou de dossier |
| -43 | Définition |
| -44 | Le déplacement du fichier entre le répertoire temporaire et le répertoire final a échoué, fichier introuvable |
| -45 | Le déplacement du fichier entre le répertoire temporaire et le répertoire final a échoué, accès refusé |
| -46 | Le déplacement du fichier entre le répertoire temporaire et le répertoire final a échoué, le fichier existe déjà et ne peut pas être écrasé |
| -47 | Le déplacement du fichier entre le répertoire temporaire et le répertoire final a échoué, nom invalide |
| -48 | Le déplacement du fichier du répertoire temporaire vers le répertoire final a échoué, le fichier existe déjà et ne peut pas être remplacé |