EVENT

Exécution d'une fonction sur changement de valeur d'une variable.

Support WebVue - Oui.

Mode	Mnémonique	Syntaxe
1	ADD, ADDPROG	1
2	ADDPROGEVT	7
3	DELPROGEVT	8
5	DEL	2
6	DELALL	3
7	IMPORTBYFILE	5
8	IMPORTBYHANDLE	6
9	ADDEMAIL	9
10	DELEMAIL	8
11	ADDPROGS	1
12	ADDSMS	10
13	DELSMS	8
14	TRACE	11
21	DELPROG	4

Tous les programmes depuis lesquels les procédures sont déclenchées doivent être préchargés.

Les noms de variables ne doivent pas être précédés par le caractère @.

L'utilisation de DELAY dans une procédure appelée périodiquement peut produire des résultats imprévisibles et doit être évitée.

Syntaxe 1

IntVal = EVENT(Mode, VarName, Sense, Prog, Branch, Func[, Farg [, ActivBit]]) ;

Type de retour : INTEGER

Argument	Définition
VarName	Nom de variable. Type STR
Sense	Sens de la transition. Voir ci-dessous
Prog	Nom du programme contenant la fonction. Type STR
Branch	Branche du programme. Type STR.
Func	Nom de la fonction à exécuter. Type STR.
Farg	Optionnel. Chaîne de 2 047 caractères maximum, contenant de 1 à 8 arguments séparés par des , (virgule). Ces arguments sont récupérables dans la fonction à exécuter par le verbe GETARG.
ActivBit	Optionnel. Nom complet de la variable état ou alarme d'activation de l'événement.

Exécution

Mode	Mnémonique	Action
1	ADD, ADDPROG	Création d'un événement déclenchant un programme. Les conditions dans lesquelles l'événement est déclenché sont définies par l'expression Sense. Si un nom de fonction n'est pas fourni, la fonction MAIN sera déclenchée. Un événement existant avec le même nom sera déclenché.
11	ADDPROGS	Création d'un événement. Les conditions dans lesquelles l'événement est déclenché sont définies par l'expression Sense. Vous pouvez créer plusieurs événements avec différentes fonctions déclenchantes et avec différents sens déclenchants pour la même variable.

Syntaxe 2

IntVal = EVENT(Mode, VarName[, Sense, Prog, Branch, Func] );

Type de retour : INTEGER

Argument	Définition
VarName	Nom de variable. Type STR.
Sense	Chaîne de caractères ou nom d'une variable de texte définissant la condition de déclenchement. Voir ci-dessous
Prog	Nom du programme contenant la fonction. Type STR.
Branch	Branche du programme. Type STR.
Func	Nom de la fonction à exécuter. Type STR.

Exécution

Mode

Mnémonique

Action

DEL

Suppression de tous les événements.

Le Sense doit être le même que l'événement original.

Si les paramètres Sense, Prog, Branch et Identity sont manquants, alors tous les événements attachés à la variable nommée sont supprimés.

Retour : 1 si OK, 0 sinon.

Syntaxe 3

IntVal = EVENT(Mode [, Type, DelAllMode]);

Type de retour : INTEGER

Argument

Mnémonique

Type

Type d'événements à supprimer. Type INTEGER.

0 = Supprime tous les événements existants, quel que soit leur type. Paramètre par défaut si Type n'est pas utilisé.
1 = Supprime uniquement les événements de type exécution de programmes.
2 = Supprime uniquement les événements de type envoi de messages électroniques.

DellAllMode

Argument optionnel pour indiquer quels événements doivent être supprimés, les temporaires créés par programme et/ou les permanents créés par configuration. Type : INTEGER.

1 = Supprime uniquement les événements temporaires (valeur par défaut),
2 = Supprime uniquement les événements permanents,
3 = Supprime à la fois les événements temporaires et les permanents.

Exécution

Mode	Mnémonique	Action
6	DELALL	Suppression de l'événement déclenchement programme nommé.
		Retour : toujours 1.

Syntaxe 4

IntVal = EVENT(Mode, VarName, Sense, Program, Branch, Function);

Argument	Définition
VarName	Nom de variable. Type STR.
Sense	Chaîne de caractères ou nom d'une variable de texte définissant la condition de déclenchement. Voir ci-dessous
Prog	Nom de la fonction à exécuter. Type STR.
Branch	Nom de branche passé en argument à la fonction appelée. Type STR.
Func	Nom de la fonction à exécuter. Type STR.

Exécution

Mode	Mnémonique	Action
21	DELPROG	L'événement déclenchant un programme unique identifié est supprimé. Tous les arguments sont obligatoires.
		Retour : 1 si OK, 0 sinon.

Sense

Sense est une expression qui définit les conditions dans lesquelles l'événement est déclenché. Les options disponibles dépendent du type de variable avec laquelle l'événement est associé.

Exécution

Voir la rubrique Conditions de variables.

Syntaxe 5

IntVal = EVENT(Mode, FileName);

Type de retour : INTEGER.

Argument	Définition
FileName	Nom du fichier texte dans le répertoire TP du projet ou dans le répertoire sélectionné par un chemin absolu. Type STR.

Les formats des fichiers d'événements, et des moyens pour les ajouter et les supprimer, sont spécifiés dans la rubrique Format pour l'import de la configuration de l'événement.

Exécution

Mode

Mnémonique

Action

IMPORTBYFILE

Import d’événements à partir du fichier dans le répertoire spécifié.

Retour :
0 si le fichier n'a pas pu être trouvé ou s'il ne contenait aucun élément à importer.
Sinon, un nombre positif correspondant au nombre de lignes traitées dans le cadre de l'import.
Une ligne peut avoir été traitée et ne pas avoir causé de changement de configuration si sa syntaxe était invalide ou si elle faisait référence à la suppression ou à la modification d'un élément qui n'existait pas dans la configuration.

Exemple

EVENT(7, "addEvent.dat");

'OR

EVENT("IMPORTBYFILE", "addEvent.dat");

Syntaxe 6

IntVal = EVENT(Mode, Handle);

Type de retour : INTEGER

Argument	Définition
Handle	Adresse du buffer d’allocation mémoire retourné par ALLOC_BUFFER. Type de retour : LONG.

Exécution

Mode

Mnémonique

Action

IMPORTBYHANDLE

Obtient des événements à partir d'un buffer.

Retour : 1 si OK, 0 sinon.

Exemple

DIM hbuf AS LONG;

hbuf = FILETOBUF("addevent.dat");

EVENT(8, hbuf);

'OR

EVENT("IMPORTBYHANDLE", hbuf);

Syntaxe 7

IntVal = EVENT(Mode, Name, Description, ServerListName, VarName, Sense, Prog, Branch, Func[, Farg [, ActiveBit]];

Type de retour : INTEGER

Argument	Définition
Name	Nom de l'événement. La chaîne de caractères saisie est celle qui apparaît dans le champ Nom de la boîte de dialogue de configuration de l'événement.
Description	Description de l'événement. La chaîne de caractères saisie apparaîtra dans le champ Description de la boîte de dialogue de configuration de l'événement.
ServerListName	Nom de la liste serveur. Dans une application multi-postes, l'événement ne sera actif que sur le poste serveur apparaissant dans la liste.
VarName	Nom d'une variable de l'arbre des variables. Type STR.
Sense	Chaîne de caractères ou nom d'une variable texte définissant la condition de déclenchement. Voir ci-dessous
Prog	Nom de branche passé en argument à la fonction appelée. Type STR.
Branch	Nom de branche passé en argument à la fonction appelée. Type STR.
Func	Nom de la fonction à exécuter. Type STR.
Farg	Facultatif. Chaîne de 2 047 caractères maximum, contenant de 1 à 8 arguments séparés par des , (virgule). Ces arguments sont récupérables dans la fonction à exécuter par le verbe GETARG.
ActiveBit	Facultatif. Nom de la variable état ou alarme qui active l'événement.

Exécution

Mode

Mnémonique

Action

ADDPROGEVT

Création d'un événement déclenchant un programme. Les conditions dans lesquelles l'événement est déclenché sont définies par l'expression Sense. Si un nom de fonction n'est pas fourni, la fonction MAIN sera déclenchée. Un événement existant avec le même nom sera déclenché.

Retour : 1 si OK, 0 sinon.

Syntaxe 8

IntVal = EVENT (Mode, Name);

Type de retour : INTEGER

Argument	Définition
Name	Nom de l'événement. La chaîne de caractères saisie est celle qui apparaît dans le champ Nom de la boîte de dialogue de configuration de l'événement.

Exécution

Mode	Mnémonique	Action
3	DELPROGEVT	Import d’événements à partir d’un buffer.
10	DELEMAIL	Suppression de l'événement e-mail nommé.
13	DELSMS	Suppression de l'événement SMS nommé.
		Retour : 1 si OK, 0 sinon.

Exemple

IntVal = EVENT (Mode, Mode, Name, Description, ServerListName, VarName, Sense, EmailTemplate, [, ActiveBit [, EmailProfile [, To [, Cc [, Bcc [, Subject [, Message [, FileAttachments [, Priority[, MessageFormat [, MessageEncoding]]]]]]]]]]])

Type de retour : INTEGER

Argument	Définition
Name	Nom de l'événement. La chaîne de caractères saisie apparaîtra dans le champ Nom de la boîte de dialogue de configuration de l'événement. Elle est également utilisée comme identifiant lors de la suppression de l'événement par programme.
Description	Description de l'événement. La chaîne de caractères saisie apparaîtra dans le champ Nom de la boîte de dialogue de configuration de l'événement.
ServerListName	Nom de la liste serveur. Dans une application multi-postes, l'événement ne sera actif que sur le poste serveur apparaissant dans la liste.
VarName	Nom de variable. Type STR
Sense	Chaîne de caractères ou nom d'une variable texte définissant la condition de déclenchement.
EmailTemplate	Nom du modèle de messagerie tel que configuré dans Actions.Messages.Modèles de message. Le champ Modèle peut être vide. Type STR.
ActiveBit	Optionnel. Nom complet de la variable état ou alarme d'activation de l'événement.
EmailProfile	Facultatif. Nom du profil de messagerie électronique tel que configuré dans Actions.Messages.Profils de messagerie. Le profil fournit des informations comme le nom du serveur sortant (SMTP). Si aucun profil n'est spécifié, le profil par défaut sera utilisé. Type STR.
To	Facultatif. Adresse des destinataires dans une liste où les noms sont délimités par des points-virgules. Type STR.
Cc	Facultatif. Adresse des destinataires en copie dans une liste où les noms sont délimités par des points-virgules. Type STR.
Bcc	Facultatif. Adresse des destinataires en copie cachée dans une liste où les noms sont délimités par des points-virgules. Type STR.
Subject	Facultatif. Objet du message électronique. Type STR.
Message	Facultatif. Corps du message électronique. Type STR.
FileAttachments	Optionnel. Liste de pièces jointes délimitée par des points-virgules. Les fichiers de la liste doivent avoir un chemin d'accès absolu. Type STR.
Priority	Facultatif. Importance du message. Tout type numérique. 0 = Normale. 1 = Basse. 2 = Haute.
MessageFormat	Optionnel. Format du corps du message électronique. Tout type numérique. 0 = Texte seulement 1 = HTML
MessageEncoding	Optionnel. Encodage du corps du message électronique. Voir la rubrique Encodage de message.

Si un modèle est spécifié et si, dans le modèle, le comportement d'une propriété est configuré comme Imposé par le modèle, les propriétés du modèle écraseront la configuration de l'instruction. Les propriétés affectées sont EmailProfile, To, Cc, Bcc, Subject, Message, Attachments, Priority, MessageFormat et MessageEncoding.

Exécution

Mode

Mnémonique

Action

ADDEMAIL

Création d'un événement envoyant un message électronique. Les conditions dans lesquelles l'événement est déclenché sont définies par l'expression Sense. Si un événement avec le même nom existe déjà, il sera remplacé.

Retour : 1 si OK, 0 sinon.

Syntaxe 10

IntVal = EVENT(Mode, Name, Description, ServerListName, VarName, Sense, MsgTemplate, [, ActiveBit [, SmsProfile [, PhoneNumbers[, Subject [, Message [, Format]]]]]]) ;

Type de retour : INTEGER

Argument	Définition
Name	Identifiant de l'événement. Type STR.
Description	Description de l'événement. Type STR.
ServerListName	Nom de la liste serveur lors de l'utilisation dans une application multi-postes. Type STR.
VarName	Nom d'une variable de l'arbre des variables, utilisée pour déclencher l'événement SMS. Type STR.
Sense	Chaîne de caractères ou nom d'une variable texte définissant la condition de déclenchement. Type STR.
MsgTemplate	Nom du modèle de message tel que configuré dans Actions.Messages.Modèles message. Type STR.
ActiveBit	Nom complet de la variable état ou alarme d'activation de l'événement. Optionnel. Type STR.
SmsProfile	Nom du profil SMS tel que configuré dans Actions.Messages.Profils SMS. Le profil fournit des informations au sujet du port de connexion et de la simcard du modem. Optionnel. Type STR.
PhoneNumbers	Numéros de téléphone des destinataires du SMS. Plusieurs numéros doivent être séparés par des points-virgules. Optionnel. Type STR.
Subject	Le sujet du SMS. Optionnel. Type STR
Message	Message du SMS. Optionnel. Type STR
Format	Format du message. Optionnel. 0 = Auto (valeur par défaut) 1 = Texte 2 = PDU 7-bit 3 = Unicode

Exécution

Mode	Mnémonique	Action
12	ADDSMS	Création d'un événement envoyant un SMS. Les conditions dans lesquelles l'événement est déclenché sont définies par l'expression Sense.

Syntaxe 11

IntVal = EVENT(Mode, SubMode);

Type de retour INTEGER.

Argument	Définition
SubMode	"ON" ou "OFF". Type STR.

Exécution

Mode

Mnémonique

Action

TRACE

Active ("ON") ou désactive ("OFF") les traces de diagnostic. Des messages trace apparaissent dans l'observateur d'événements (F7) et sont générés à chaque fois qu'un événement est déclenché.

Retour : 1 si OK, 0 sinon.

Exemple de message de trace

[SV.Events] Les traces sont activées

[SV.Event.Program]<Branch01.Branch02.Bit01:Session.Event01> Run program=p.scb function=VarEvent args= Branch=

[SV.Event.E-mail]<Branch01.Branch02.Bit05:Session.Event01> Send Email or Sms or Fax, subject=Test From Bit05

Exemple

Pour autres exemples, suivez le lien Exemple en haut de cette page.

EVENT

Syntaxe 1

Exécution

Syntaxe 2

Exécution

Syntaxe 3

Exécution

Syntaxe 4

Exécution

Sense

Exécution

Syntaxe 5

Exécution

Exemple

Syntaxe 6

Exécution

Exemple

Syntaxe 7

Exécution

Syntaxe 8

Exécution

Exemple

Exécution

Syntaxe 10

Exécution

Syntaxe 11

Exécution

Exemple de message de trace

Exemple

Envoyez-nous vos commentaires