FileMove()
- Last UpdatedSep 24, 2024
- 2 minute read
Déplace un fichier source sous un fichier destination et retourne un état dans le résultat. La fonction permet également de renommer un fichier. Cette fonction peut prendre plus de temps et s'exécute en plusieurs étapes<:hs>:
-
La fonction FileMove() est appelée et un résultat est immédiatement renvoyé, pour indiquer le succès ou l'échec de l'initialisation de l'opération.
-
La fonction FileMove() exécute l'opération en arrière-plan, pendant que le script InTouch continue son exécution. Vous pouvez surveiller le progrès de l'opération avec une variable entière.
-
La fonction FileMove() renvoie un résultat indiquant le succès ou l'échec de l'opération.
N'utilisez pas la fonction FileMove() dans des QuickFonctions asynchrones.
Syntaxe
result = FileMove (sourcefile, destfile, progresstag)
Paramètres
sourcefile
Chemin complet et nom du fichier à déplacer. Chaîne littérale, variable message ou expression chaîne. Vous pouvez utiliser les caractères génériques (* et ?) dans ce paramètre pour déplacer uniquement les fichiers qui coïncident avec un critère spécifié. Le chemin peut être également en notation UNC.
destfile
Chemin complet et nom du fichier (ou seulement le chemin) de la destination. Chaîne littérale, variable message ou expression chaîne. Le chemin peut être également en notation UNC.
progresstag
Nom d'une variable entière entre doubles guillemets qui sera renseignée avec un indicateur du progrès de l'opération. Chaîne littérale, variable message (par exemple une variable message contenant la valeur «<:hs>IntTag<:hs>») ou expression chaîne. Les valeurs ont la signification suivante<:hs>:
0 - procédure FileMove() encore en cours d'exécution
1 - La procédure FileMove() s'est terminée avec succès
-1 - la procédure FileMove() s'est terminée avec des erreurs
Valeur retour
Une valeur -1, 0 ou 1 pour indiquer :
1 - fonction FileMove() appelée avec succès
0 - erreur de l'appel à la fonction FileMove(), une autre procédure FileMove() est déjà en cours
-1 - erreur de l'appel à la fonction FileMove(). Une raison possible est la tentative de déplacement d'un fichier introuvable.
Exemple(s)
Ce script déplace le fichier c:\MyData\output.log sous le répertoire d:\archive et renomme le fichier en output.txt. La progression de l'opération de déplacement est reportée dans la variable entière Monitor.
Status=FileMove("c:\MyData\output.log","d:\archive\output.txt","Monitor");
Ce script déplace tous les fichiers avec extension.txt du répertoire racine c:\ vers le répertoire destination c:\Backup.
Status=FileMove("c:\*.txt", "c:\Backup", "Monitor");
Ce script déplace un fichier dont le chemin et le nom sont contenus dans la variable message LogFile, vers le répertoire destination c:\results\ et le renomme en logxxx.txt, où xxx est un horodatage.
Status=FileMove(LogFile, "c:\results\log" + $DateString + $TimeString + ".txt", "Monitor");