Manuel des Scripts Automation Engine > Organisation fonctionnelle > Séquences de données > PREP_PROCESS_DOCU

PREP_PROCESS_DOCU

Fonction de script : Met à disposition le contenu d'un onglet de documentation comme liste interne (séquence de données) pour un traitement ultérieur.

Syntaxe

PREP_PROCESS_DOCU( Nom de l'objet [, onglet docu.] )

Syntaxe

Description / format

Nom d'objet

Nom d'un objet au choix dont l'onglet de documentation doit être lu.

Format : littéral de script ou variable de script

Onglet docu.

Nom de l'onglet de documentation
Format : littéral de script ou variable de script

En l'absence d'indication, l'onglet de documentation avec le nom "Docu" est recherché.

Codes retour

Référence à la séquence de données qui comprend le contenu de l'onglet de documentation souhaité.

Commentaires

L'élément de script lit le contenu d'un onglet de documentation spécifique d'un objet (les onglets de documentation sont disponibles pour tous les types d'objets) et le met à disposition sous forme d'une séquence de données pour le traitement suivant. Les noms de l'objet et de l'onglet de documentation doivent être indiqués (comme défini dans la Variable UC_OBJECT_DOCU).

Vous pouvez aussi bien indiquer un onglet docu. simple (= contient uniquement un texte) qu'un onglet docu. structuré.
Dans l'onglet docu. structuré, tous les éléments définis à gauche de l'onglet sont enregistrés ligne par ligne dans la séquence de données. Si un onglet docu. simple est indiqué, son contenu (texte) sera transféré ligne par ligne dans la séquence de données.

La casse des caractères n'a pas d'importance pour la saisie du nom de l'onglet de documentation. Exemple : si vous saisissez "docu" dans la recherche, vous trouverez tout de même l'onglet "Docu".

Si aucun onglet de documentation ne peut être trouvé avec le nom indiqué, la fonction de script ne s'interrompt pas. Dans ce cas, la séquence de données n'est pas uniquement remplie. Une interruption se produit uniquement si le nom de l'objet est invalide.

Exemples

Dans l'exemple suivant, l'onglet de documentation "Docu" de l'objet SCRI.TEST est lu et son contenu est affiché dans le rapport d'activation.

:SET &HND# = PREP_PROCESS_DOCU(SCRI.TEST,Docu)
:PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE(&HND#)
: PRINT &LINE#
:ENDPROCESS

:CLOSE_PROCESS &HND#

 

Rubriques connexes :

Eléments de script Définition

:PROCESS... :TERM_PROCESS... :ENDPROCESS

Définissent une boucle pour le traitement par lignes d'une séquence de données, comme le contenu d'un fichier séquentiel ou le résultat de type texte d'une commande.

GET_PROCESS_LINE

Détermine le contenu actuel des lignes d'une séquence de données.