PREP_PROCESS_COMMENTS

Fonction de script : Utilise les paramètres de filtre pour récupérer l'horodatage, l'utilisateur et le texte des commentaires des tâches et fournit le résultat sous la forme d'une liste interne (séquence de données) pour un traitement ultérieur.

Syntaxe

PREP_PROCESS_COMMENTS ([RUN#] [,Text] [, user])

Syntaxe	Description / format
RunID	Numéro d'exécution (RunID) de la tâche dont les commentaires doivent être lus. Format : littéral de script, variable de script ou nombre Si vous n'indiquez aucun RunID, les commentaires de la tâche qui appelle l'instruction de script sont lus.
Text	Filtre permettant de rechercher une expression dans le texte des commentaires Format : littéral de script ou variable de script 200 caractères maximum Valeur par défaut : "*" Les caractères génériques "*" et "?" sont autorisés. "*" signifie n'importe quelle chaîne de caractères et "?" exactement un caractère.
User	Filtre permettant de rechercher le nom d'un objet utilisateur Format : littéral de script ou variable de script 200 caractères maximum Valeur par défaut : "*" Les caractères génériques "*" et "?" sont autorisés. "*" signifie n'importe quelle chaîne de caractères et "?" exactement un caractère. La première virgule doit être conservée si vous ne filtrez que sur le nom d'utilisateur. Voir l'exemple suivant : :SET &HND# = PREP_PROCESS_COMMENTS(,,"SMITH/AE")

Code retour
Référence sur la séquence de données des commentaires.

Cette fonction de script lit les commentaires d'une tâche. Le résultat peut être limité à l'aide des paramètres Text et User.

Les majuscules et minuscules sont prises en compte dans les spécifications du filtre.

Notez qu'une chaîne vide "" utilisée pour définir le filtre équivaut à entrer "*" : toutes les valeurs sont alors renvoyées.

Le code retour de cette fonction de script est la référence d'une séquence de données qui est assignée aux instructions de script :PROCESS et :ENDPROCESS en tant que paramètre de démarrage. Vous pouvez accéder à chaque commentaire d'une tâche en utilisant la fonction de script GET_PROCESS_LINE.

Aucun message d'erreur n'est envoyé si les valeurs recherchées ne sont pas incluses dans le commentaire. Le traitement de la séquence de données qui est défini entre :PROCESS et :ENDPROCESS, n'est tout simplement pas lancé.

Aucune nouvelle valeur ne peut être attribuée à la variable de script contenant la référence de la séquence de données. La séquence de données doit tout d'abord être supprimée avec l'instruction de script CLOSE_PROCESS pour que la variable puisse être réutilisée.

Exemples

Les commentaires suivants sont fournis :

Le premier exemple récupère tous les commentaires et :PRINT affiche l'utilisateur et le texte.

:SET &HND# = PREP_PROCESS_COMMENTS()

:PROCESS &HND#
:   SET &USER# = GET_PROCESS_LINE(&HND#,2)
:   SET &TEXT# = GET_PROCESS_LINE(&HND#,3)
:   PRINT "&USER#:  &TEXT#"
:ENDPROCESS

:CLOSE_PROCESS &HND#

Le deuxième exemple lit uniquement les entrées de Monsieur Smith et les écrit en incluant un horodatage.

:SET &HND# = PREP_PROCESS_COMMENTS(,,"SMITH/AE")

:PROCESS &HND#
:   SET  &TIME# = GET_PROCESS_LINE(&HND#,1)
:   SET &TEXT# = GET_PROCESS_LINE(&HND#,3)
:   PRINT "&TIME#:  &TEXT#"
:ENDPROCESS

:CLOSE_PROCESS &HND#

Dans le troisième exemple, la fonction de script est appelée à partir d'une tâche différente, d'où le RunID. Le résultat fournit tous les textes du commentaire qui contiennent le mot "fichier".

:SET &RunID = GET_UC_OBJECT_NR(MM.RETRIEVE.FILES)

:SET &HND# = PREP_PROCESS_COMMENTS(&RunID,"*file*")

:PROCESS &HND#
:   SET &TEXT# = GET_PROCESS_LINE(&HND#,3)
:   PRINT "Comment: &TEXT#"
:ENDPROCESS

:CLOSE_PROCESS &HND#

Voir aussi :