|
|
|
|
|
- Codes d'erreur
- Fichier extrait
- Extraction et mot de passe
- Indice des fichiers dans l'archive
- Chemin mémorisé
zipExtraitFichier (Fonction) En anglais : zipExtractFile Extrait et décompresse automatiquement un fichier d'une archive à un emplacement physique ou en mémoire.
Avertissement
Ce mode d'extraction des fichiers d'une archive peut être relativement lent. Pour extraire plusieurs fichiers, il est conseillé d'utiliser les fonctions zipExtraitTout ou zipExtraitRépertoire.
Syntaxe
Extraire un fichier identifié par son indice Masquer les détails
<Résultat> = zipExtraitFichier(<Archive> , <Indice du fichier> [, <Destination du fichier> [, <Progression>]])
<Résultat> : Entier ou buffer - 0 si le fichier a été extrait,
- Un code d'erreur (valeur supérieure à 0) dans le cas contraire. Pour plus de détails sur ces codes d'erreur, consultez les Remarques.
Lors d'une extraction "en mémoire", correspond au buffer contenant le fichier extrait.
<Archive> : Chaîne de caractères ou variable de type zipArchive Nom de l'archive à manipuler. Ce nom peut correspondre : <Indice du fichier> : Entier Indice du fichier à extraire de l'archive. Cet indice peut être connu grâce à la fonction zipChercheFichier. <Destination du fichier> : Chaîne de caractères ou constante optionnelle Chemin de destination du fichier extrait :- Chaîne de caractères optionnelle : Le fichier est extrait dans le chemin spécifié auquel s'ajoute l'arborescence mémorisée du fichier (le disque n'est pas conservé). Le chemin spécifié est créé s'il n'existe pas.
- Constante optionnelle :
| | zipAucun | Extraction dans le répertoire en cours sans restauration de l'arborescence du fichier (si elle a été mémorisée). | zipDisque | Extraction :- à l'emplacement d'origine du fichier s'il a été mémorisé et si le disque existe.
- avec restauration de l'arborescence du fichier sur le disque en cours si le disque ou si le répertoire mémorisé n'existe pas.
- dans le répertoire en cours si seuls le nom et l'extension du fichier ont été mémorisés.
Archives au format 7z : Cette constante aura le même effet que la constante zipRépertoire. | zipEnMémoire | Extraction du fichier en mémoire. Le contenu du fichier est renvoyé directement par la fonction. Il peut être affecté à une variable de type Buffer par exemple. Cette fonctionnalité est disponible uniquement pour les archives au format ZIP et WDZ. | zipRépertoire (Valeur par défaut) | Extraction dans le répertoire en cours avec restauration de l'arborescence du fichier (si elle a été mémorisée). |
<Progression> : Nom de champ ou nom de procédure Mode de gestion de la jauge. Ce paramètre peut correspondre : - au nom d'une procédure WLangage. Cette procédure est de la forme :
<Nom de la procédure> (<Fichier en cours>, <Pourcentage d'avancement>) où : - <Fichier en cours> correspond au nom du fichier en cours de traitement.
- <Pourcentage d'avancement> correspond au pourcentage d'avancement de l'extraction du fichier en cours depuis l'archive.
Attention : La jauge est mise à jour uniquement à la fin de l'extraction du fichier pour les archives de type : - TAR ou TGZ (TAR.GZ),
- RAR,
- CAB.
Extraire un fichier identifié par son chemin Masquer les détails
<Résultat> = zipExtraitFichier(<Archive> , <Chemin du fichier> [, <Destination du fichier> [, <Progression>]])
<Résultat> : Entier ou buffer - 0 si le fichier a été extrait,
- Un code d'erreur (valeur supérieure à 0) dans le cas contraire. Pour plus de détails sur ces codes d'erreur, consultez les Remarques.
Lors d'une extraction "en mémoire", correspond au buffer contenant le fichier extrait.
<Archive> : Chaîne de caractères ou variable de type zipArchive Nom de l'archive à manipuler. Ce nom peut correspondre : <Chemin du fichier> : Chaîne de caractères Chemin mémorisé du fichier à extraire de l'archive. Effectue une recherche à l'identique sur le chemin du fichier dans l'archive. <Destination du fichier> : Chaîne de caractères ou constante optionnelle Chemin de destination du fichier extrait :- Chaîne de caractères optionnelle : Le fichier est extrait dans le chemin spécifié auquel s'ajoute l'arborescence mémorisée du fichier (le disque n'est pas conservé). Le chemin spécifié est créé s'il n'existe pas.
- Constante optionnelle :
| | zipAucun | Extraction dans le répertoire en cours sans restauration de l'arborescence du fichier (si elle a été mémorisée). | zipDisque | Extraction :- à l'emplacement d'origine du fichier s'il a été mémorisé et si le disque existe.
- avec restauration de l'arborescence du fichier sur le disque en cours si le disque ou si le répertoire mémorisé n'existe pas.
- dans le répertoire en cours si seuls le nom et l'extension du fichier ont été mémorisés.
Archives au format 7z : Cette constante aura le même effet que la constante zipRépertoire. | zipEnMémoire | Extraction du fichier en mémoire. Le contenu du fichier est renvoyé directement par la fonction. Il peut être affecté à une variable de type Buffer par exemple. Cette fonctionnalité est disponible uniquement pour les archives au format ZIP et WDZ. | zipRépertoire (Valeur par défaut) | Extraction dans le répertoire en cours avec restauration de l'arborescence du fichier (si elle a été mémorisée). |
<Progression> : Nom de champ ou nom de procédure Mode de gestion de la jauge. Ce paramètre peut correspondre : - au nom d'une procédure WLangage. Cette procédure est de la forme :
<Nom de la procédure> (<Fichier en cours>, <Pourcentage d'avancement>) où : - <Fichier en cours> correspond au nom du fichier en cours de traitement.
- <Pourcentage d'avancement> correspond au pourcentage d'avancement de l'extraction du fichier en cours depuis l'archive.
Attention : La jauge est mise à jour uniquement à la fin de l'extraction du fichier pour les archives de type : - TAR ou TGZ (TAR.GZ),
- RAR,
- CAB.
Remarques Codes d'erreur Les codes d'erreur retournés sont les suivants : - 1 : Le chemin passé en paramètre n'existe pas.
- 2 : Accès interdit : l'utilisateur n'a pas les droits nécessaires.
- 3 : L'archive est corrompue.
- 4 : Le chemin n'existe pas dans l'archive.
- 6 : Les fichiers des sous-archives ne sont pas dans l'ordre (cas d'une extraction dans une archive multi-parties).
- 21 : Le mot de passe spécifié n'est pas correct.
Le message correspondant au code d'erreur peut être connu grâce à la fonction zipMsgErreur.
Rappel : - Le format RAR est géré jusqu'à la version 4 incluse.
Fichier extrait Le fichier extrait n'est pas effacé de l'archive. Pour effacer un ou tous les fichiers de l'archive, utilisez la fonction zipSupprimeFichier ou zipSupprimeTout. Indice des fichiers dans l'archive Lors de l'ajout d'un fichier dans une archive, un indice est automatiquement attribué au fichier. Cet indice correspond à l'ordre d'intégration des fichiers dans l'archive. Pour sélectionner un fichier de l'archive, il est possible d'utiliser : - soit l'indice de l'élément (l'indice d'un élément peut être connu grâce à la fonction zipChercheFichier).
- soit le chemin mémorisé de l'élément.
Chemin mémorisé Le tableau ci-dessous présente les chemins mémorisés dans l'archive en fonction : - du chemin d'accès du fichier,
- de la portion mémorisée du chemin.
Le répertoire en cours est : "C:\Temp". | | | | | Fonction zipAjouteFichier | Localisation du fichier | zipAucun | zipRépertoire | zipDisque | zipAjouteFichier("Archi",... "Fichier.txt") | C:\Temp\Fichier.txt | Fichier.txt | Fichier.txt | Fichier.txt | zipAjouteFichier("Archi",... "Donnée\Fichier.txt") | C:\Temp\Donnée\Fichier.txt | Fichier.txt | Donnée\Fichier.txt | Donnée\Fichier.txt | zipAjouteFichier("Archi",... "D:\Donnée\Fichier.txt") | D:\Donnée\Fichier.txt | Fichier.txt | Donnée\Fichier.txt | D:\Donnée\Fichier.txt | Remarque : Si la constante zipDisque est utilisée : - le format WDZ mémorise le chemin complet du fichier (lettre du lecteur comprise).
- le format ZIP ne mémorise pas la lettre du lecteur.
- le format 7z mémorise uniquement les répertoires.
Classification Métier / UI : Code métier Composante : wd300zip.dll
Documentation également disponible pour…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|