Aller au contenu principal
Version: v4 (Stable)

EnumAlarm

EnumAlarm(AlarmId As String/Integer, AlarmState As Integer[, AckUserId As Integer[, bDataServer As Boolean[, StationId As Integer]]]) As Integer

Retourne dans <AlarmId> l'identificateur de l'alarme suivant l'identificateur spécifié en entrée dans <AlarmId>. Le paramètre <AlarmId> peut être l'OId numérique du tag alarme ou son identificateur alphanumérique en fonction du type du paramètre (Integer ou String). Pour initialiser l'énumération, écrire 0 dans <AlarmId> (Integer) ou une chaîne vide (String).

Si <bDataServer> est spécifié avec la valeur TRUE, la fonction énumère seulement les alarmes attachées au serveur de données contextuel.

Le paramètre optionnel <StationId> permet de filtrer la recherche sur la station définie. S'il est omis ou fixé à 0, la recherche s'effectue sur toutes les stations.

L'état de l'alarme est retourné dans <AlarmState>. Il est défini par les masques de bits suivants :

  • bit 0 (masque &h01) : état d'activation de l'alarme (1 = alarme active)
  • bit 1 (masque &h02) : état d'acquittement de l'alarme (1 = alarme non acquittée)
  • bit 2 (masque &h04) : alarme masquée par un opérateur (1 = alarme masquée)
  • bit 5 (masque &h20) : état de masquage courant de l'alarme (1 = alarme masquée par un opérateur, une condition de masquage, une autre alarme ou par programme)
  • bit 6 (masque &h40) : défaut de connexion (croix rouge)
  • bit 7 (masque &h80) : variable hors scrutation (croix bleue)

Si <nAckUserId> est spécifié, la fonction retourne dans <AckUserId> l'Oid de l'opérateur ayant acquitté l'alarme (0 si alarme non acquittée).

La fonction retourne : 0 : Si pas d'erreur. 6 : S'il n'y a pas d'alarme suivante.