Cette fonctionnalité a été actualisée en 05.10
Voir les anciennes versions ci-dessous.
|
Anciennes versions |
Documentation |
|---|---|
|
Avant la 05.10 |
BUT
Cette fonction permet d’écrire dans un fichier ascii un message XML dont le contenu est décrit dans la liste standard WfEIAXmlMes, contenu du message structuré sous forme de liste et accessible avec les instructions de manipulation DIALOG.
TYPE CARACTERE
SYNTAXE
Variable = XML-ECRMESFIC (REF-MESSAGE-XML = référence message XML,
NOM-FICHIER= nom absolu du fichier ascii XML,
BALISE-DEPART = balise départ du message,
ENCODAGE = encodage choisi pour le fichier XML
)
PARAMETRES
|
Paramètre |
E/S |
O |
Type |
Description |
|
REF-MESSAGE-XML |
E |
Oui |
Caractère |
Référence Message XML mémorisé dans la structure WfEIAXmlMes : cette structure contient le contenu du message XML. L’initialisation permet de renseigner ou non une référence de message (utile uniquement dans le cas où plusieurs messages ont été précédemment initialisés). La valeur peut être MESSAGE-COURANT (cas où un seul message a été initialisé : la référence message sera alors vide (CLO. ‘’)) ou bien peut être définie par une variable locale, une constante (locale ou globale) ou une variable contextuelle. |
|
NOM-FICHIER |
E |
Oui |
Caractère |
Nom du fichier ascii (avec adresse ou répertoire complet) contenant le message XML à écrire. La valeur peut être définie par une variable locale, une constante (locale ou globale) ou une variable contextuelle. |
|
BALISE-DEPART |
E |
Oui |
Caractère |
Valeur de la balise de départ (de plus haut niveau) du message XML. La valeur est transmise dans une variable locale. |
|
ENCODAGE |
E |
Non |
Caractère |
Encodage souhaité pour le fichier XML. Par défaut celui de Diapason (ISO8859-15). Peut être défini par une variable locale, une constante (locale ou globale) ou choix dans la liste des encodages proposés (ISO8859-1, ISO8859-13, UTF-8). |
Suite à son exécution, cette fonction retourne une valeur sous forme de variable pour préciser si le déroulement a été correct ou non : la variable retournée est vide si la fonction s’est déroulée correctement, sinon la variable contient *ERR suivie d’un code et libellée d’erreur ou *INC si l’exécution n’a pas pu être réalisée correctement.
EXEMPLE
VLO.Fonction = XML-ECRMESFIC( REF-MESSAGE-XML= MESSAGE-COURANT , NOM-FICHIER= VCR.NomFichierXMLAEcrire, BALISE-DEPART= VLO.Balise, ENCODAGE = “UTF-8”)
Cette instruction permet d’écrire dans le fichier ascii défini dans la variable locale VCR.NomFichierXMLAEcrire le message XML contenu dans la liste structurée WfEIAXmlMes avec la référence message (ou identfiant) à vide (CLO.’’) et encodé en UTF-8.
NOTES
La structure de la liste WfEIAXmlMes est la suivante :
|
Champ |
Désignation |
|
MesIde |
Référence Message (à vide si valeur MESSAGE-COURANT) |
|
XmlPId |
Identifiant Balise Père. |
|
XmlIde |
Identifiant Balise Courante |
|
XmlNiv |
Niveau Courant dans l’arborescence du message |
|
XmlNOr |
Numéro Ordre du lien par rapport au Niveau Courant |
|
XmlTBa |
Type : L(ien), V(aleur), A(ttribut) |
|
XmlBal |
Nom de la Balise XML |
|
XmlVal |
Valeur Rattachée a Balise XML |