Aller au contenu principal
Version: v4 (Stable)

SetAction

SetAction(AlarmId As Integer/String, Type As Integer, ActionType As Integer, ActionId As Integer/String[, ActionFlags As Integer[, ActionParam As String[, bAddAction As Boolean]]]) As Integer

Crée ou modifie une action pour la variable d'alarme désignée par <AlarmId> (Identificateur numérique ou alphanumérique de la variable).

Le paramètre <Type> est un masque de bits définissant les types d’événement pour lesquels l'action est valide :

  • &h01 = alarme,
  • &h02 = retour à la normale,
  • &h04 = acquittement alarme.

Le paramètre <ActionType> définit le type d'action :

  • 0 : Appel du groupe d'astreinte désigné par <ActionId>
  • 1 : Appel de l'opérateur désigné par <ActionId> Le paramètre <ActionId> désigne l'objet (groupe d'astreinte ou opérateur) par son identifiant (Integer) ou son nom (String).

Le paramètre optionnel <ActionFlags> est à 0 par défaut pour les appels standards. Le paramètre optionnel <ActionParam> n'est pas utilisé et devra rester vide. Si le paramètre optionnel <bAddAction> est TRUE (valeur par défaut), l'action sera ajoutée à la liste d'action existante. S'il est FALSE, la liste d'actions sera réinitialisée avec la nouvelle action.

Retourne 0 s'il n'y a pas d'erreur.