Aller au contenu principal
Version: v4 (Stable)

CreateAlarm

CreateAlarm(AlarmId AS String, CallGroup AS String, AlarmGroup AS String, Message As String, Priority AS Integer, Flags AS Integer[, Format AS String[, nDelay AS Integer[, sStation AS String]]]) AS Integer

Crée une alarme désignée par l'identificateur <AlarmId>.

<CallGroup> définit le groupe d'astreinte à appeler (peut être vide si non défini). <AlarmGroup> définit le groupe fonctionnel de l'alarme (peut être vide si non défini). <Message> définit le message texte associé à l'alarme. <Priority> définit la priorité de l'alarme. <Format> définit le format d'affichage du message (paramètre optionnel). <nDelay> définit le retard d'appel (sec). <sStation> définit la station où créer l'alarme (station locale par défaut).

<Flags> peut contenir les indicateurs booléens suivants : &h01 = Création du groupe d'astreinte si inexistant. &h02 = Alarme transitoire (retour à la normale automatique). &h04 = Alarme temporaire (détruite automatiquement lorsqu'elle est inactive et acquittée). &h08 = Alarme locale. &h10 = Mise à jour du groupe d'astreinte. &h20 = Pas de mise à jour du message. &h40 = Création du groupe d'alarme multi-station. &h80 = Evénement simple. &h100 = Alarme réactivable. &h200 = Appel groupe désactivé.

Si le tag <AlarmId> est déjà défini, les paramètres <Message>, <Priority> et <Format> sont mis à jour.

Retourne un code d'erreur (0 si pas d'erreur).