Cette fonction permet d'ouvrir un fichier texte.
Important : pour un alias donné, la dll VaToolBx doit être déjà chargée (ordre CHARGER_DLL) au moment de l'appel de la fonction VaToolBxOpenFile.
Domaine d'application
Client Windows,
Serveur Windows,
Client Mobile,
Serveur Mobile,
Client Java,
Serveur Java,
Client Adélia Web,
Client Adélia Cloud.
Remarque : la gestion de l'encodage et le mode 'i' ne sont pas pris en compte en génération mobile.
ALPHA(n) |
Alias |
Nom logique donné au fichier à ouvrir. |
ALPHA(n) ou IMAGE |
NomFichier ou Buffer |
Chemin d'accès et nom du fichier (physique) à ouvrir, ou Buffer mémoire géré à l'aide d'une variable IMAGE.
Remarque : le paramètre IMAGE Buffer concerne le contexte Java exclusivement.
|
ALPHA(n) |
Mode |
Mode d'ouverture du fichier :
| r |
Lecture |
| w |
Ecriture |
| a |
Ajout |
| t |
Ouverture du fichier en mode texte (mode par défaut). Dans ce mode, les combinaisons de caractères carriage return-linefeed (caractères 0D-0A) sont remplacées par le caractère linefeed (0A) en lecture, ce dernier étant lui-même remplacé par la combinaison de caractères carriage return-linefeed en écriture.
Les caractères sont convertis selon l'encodage précisé, ou, par défaut :
-
- ANSI pour la plateforme C/Windows
- L'encodage de la JVM pour la plateforme Java, soit ANSI en Windows et UTF-8 en Linux.
S'il est présent, ce mode doit être utilisé avec un des modes lecture (r), écriture (w) ou ajout (a).
(Par exemple : rt, wt, at) |
| b |
Ouverture du fichier en mode pseudo binaire. Dans ce mode, il n'y a pas de gestion particulière des caractères carriage return-linefeed. Les caractères sont convertis selon l'encodage précisé, ou, par défaut :
-
- ANSI pour la plateforme C/Windows
- L'encodage de la JVM pour la plateforme Java, soit ANSI en Windows et UTF-8 en Linux.
S'il est présent, ce mode doit être utilisé avec un des modes lecture (r), écriture (w) ou ajout (a).
(Par exemple : rb, wb, ab) |
| i |
Ouverture du fichier en mode binaire strict. Dans ce mode, aucune conversion de caractères n'est effectuée. Les octets sont lus ou écrits sans aucune conversion : le fait de préciser un encodage retourne une erreur 14. S'il est présent, ce mode doit être utilisé avec un des modes lecture (r), écriture (w) ou ajout (a). (Par exemple : ri, wi, ai) |
|
Remarque : les modes t, b et i sont exclusifs.
,enc=UNICODE ,enc=ANSI ,enc=ASCII ,enc=UTF-8 ,enc=UTF-8-NO-BOM ,enc=UTF-16LE ,enc=UTF-16LE-NO-BOM ,enc=UTF-16BE ,enc=UTF-16BE-NO-BOM ,enc=UTF-32LE ,enc=UTF-32LE-NO-BOM ,enc=UTF-32BE ,enc=UTF-32BE-NO-BOM
Permet de préciser pour le mode texte (t) ou le mode pseudo binaire (b), l'encodage des caractères à utiliser.
Remarque : Lorsque l'encodage est précisé de façon explicite, alors en mode lecture ou ajout, l'encodage utilisé est en priorité celui de la BOM du fichier si elle existe. En mode écriture ou ajout dans un fichier vide, les encodages UTF-8, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE ajoutent systématiquement une BOM dans le fichier ; il faut utiliser le même nom d'encodage enrichi de "–NO-BOM" pour obtenir un fichier sans BOM. Par défaut l'encodage est l'ANSI. En l'absence de BOM ou en mode écriture, l'encodage UNICODE est équivalent à l'encodage UTF-16BE.
|
|
NUM_BIN_4 |
CodeRetour |
Code retour de l'opération : 0 L'opération s'est déroulée correctement. 2 L'alias est déjà utilisé. 3 Le fichier n'a pu être ouvert. 7 Problème mémoire. 9 Problème d'initialisation du convertisseur de caractères. 10 Erreur lors de l'écriture de la BOM. 13 Mode d'ouverture non valide. 14 Encodage incompatible avec le mode d'ouverture. 15 Encodage non reconnu/supporté. |
Exemple 1 :
Alias = 'FichierTexte'
NomFichier = 'C:\CONFIG\USER.TXT'
Mode = 'w'
APPELER_DLL 'VATOOLBX.DLL' 'VaToolBxOpenFile' Alias NomFichier Mode CodeRetour
Exemple 2 (contexte Java uniquement) :
IMAGE Buffer
Alias = 'idInf1'
Mode = 'w'
APPELER_DLL 'VATOOLBX.DLL' 'VaToolBxOpenFile' Alias Buffer Mode CodeRetour
Exemple 3 :
Alias = 'FichierTexte_UTF8'
NomFichier = 'C:\CONFIG\USER.TXT'
Mode = 'w,enc=UTF-8'
APPELER_DLL 'VATOOLBX.DLL' 'VaToolBxOpenFile' Alias NomFichier Mode CodeRetour
Liste des fonctions de la DLL VaToolBx par thème
↑ Haut de page
