DESCRIPTION.

La fonction FN_skipTo() retourne le niveau hiérarchique d'une balise commençant par une suite de caractères spécifiée.

SYNTAXE.

kniveau = FN_skipTo( structure{} , suite , niveau )

REMARQUES

structure{} doit être l'identifiant de la structure de données qui a été retourné par l'appel de la procédure PROC_initXML().

suite doit être une chaine de caractères quelconque, mais valide, et ne pas commencer par le chevron ouvrant (<), celui-ci étant ajouté automatiquement par la fonction FN_skipTo() pour la recherche. suite est la suite de caractères qui est recherchée, si plusieurs balises commencent par suite, par exemple <nom> et <nombre>, c'est le niveau de la première balise commençant par  suite trouvée qui sera retournée. 

niveau doit être un nombre entier strictement positif, indiquant le plus petit niveau hiérarchique auquel soit se trouver balise pour valide. Si niveau vaut 0, la fonction FN_skipTo() analysera le reste du fichier et si niveau est le niveau actuel, tel que retourné par la fonction FN_getLevel(), seul le reste du bloc, du niveau, en cours sera analysé.

L'appel de la fonction FN_skipTo() va parcourir le fichier .xml ouvert avec la procédure PROC_initXML() jusqu'à trouver suite dans l'intitulé d'une balise ou jusqu'à ce que son niveau dans la hiérarchie soit inférieur à niveau. La valeur retournée par l'appel de la fonction FN_skipTo() correspond au niveau auquel suite a été trouvée, ou 0 si suite est introuvable dans la portée spécifiée, ou si la fin du fichier est atteinte.

Le niveau de base, de la première balise, est 1. Si la procédure PROC_exitXML() a été appelée, la valeur renvoyée sera zéro.

Voir l'instruction DIM{} pour plus de détails sur les structures de données.

Voir la fonction FN_skipToRet() qui retourne le niveau et l'intitulé complet de la balise trouvée.

Rappel : La procédure PROC_initXML() doit toujours être appelée avant toute autre procédure ou fonction définie dans le module xmllib.bbc.

La fonction FN_skipTo() est importée depuis le module xmllib.bbc.

EXEMPLE.

INSTALL @lib$ + "xmllib.bbc"

PROC_initXML( XML_donnees{} , "monfichier.xml" )

kniveau = FN_skipTo( XML_donnees{} , "nom" , 0 )

PRINT kniveau

PROC_exitXML( XML_donnees{} )

END