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 ( ObjectName, [Documentation tab] )
|
Syntaxe |
Description / format |
|---|---|
|
Object name |
Nom d'un objet au choix dont l'onglet de documentation doit être lu. Format : littéral de script ou variable de script |
|
Documentation tab |
Nom de l'onglet de documentation Si vous ne spécifiez pas de nom, le système recherche l'onglet de documentation "Docu". |
|
Codes retour |
|---|
|
Référence de la séquence de données qui contient le contenu de l'onglet de documentation souhaité. |
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. Notez que vous devez spécifier le nom de l'objet et de l'onglet de documentation tels qu'ils sont définis dans la variable UC_OBJECT_DOCU.
Vous pouvez spécifier un onglet documentation simple (qui contient uniquement un texte) ou structuré.
Un onglet Documentation structuré enregistre tous les éléments définis dans la partie gauche de l'onglet dans la séquence de données, ligne par ligne. Le contenu (texte) d'un onglet Documentation simple est transféré ligne par ligne dans la séquence de données.
Les majuscules et minuscules sont ignorées dans le nom de l'onglet de documentation. Par exemple, si vous saisissez "docu" dans la recherche, vous trouverez tout de même l'onglet "Docu".
La fonction de script ne s'interrompt pas si le système ne trouve d'onglet de documentation avec le nom spécifié. Le seul effet est que la séquence de données n'est pas remplie avec le contenu dans ce cas. La fonction de script ne s'interrompt que si le nom de l'objet n'est pas valide.
Exemples
L'exemple suivant illustre la lecture de l'onglet de documentation "Docu" de l'objet SCRI.TEST et écrit son contenu 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#
Voir aussi :