Aller au contenu principal
Version: v4 (Stable)

GetAlarmStatus

GetAlarmStatus(AlarmId As String/Integer, AlarmState As Integer, AlarmTime As Time, ResetTime As Time, AckTime As Time, UserId As String/Integer) As Integer.

Retourne l'état d'alarme complet de la variable identifiée par <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).

L'état de l'alarme est retourné dans <AlarmState>. Si la valeur de <AlarmState> est nulle, l'alarme n'est pas masquée et n'est pas présente dans la table des alarmes. Sinon, l'état de l'alarme 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) : état de masquage de l'alarme (1 = alarme masquée)
  • 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).

Retourne l'heure de déclenchement de l'alarme dans <AlarmTime>, l'heure de retour à la normale dans <ResetTime> et l'heure d'acquittement dans <AckTime>, toutes les heures étant retournées en heure locale.

L'identifiant ou le nom (suivant le type du paramètre) de l'opérateur qui a acquitté l'alarme est retourné dans <UserId>.

Cette fonction retourne un code d'erreur (0 pas d'erreur, 6 si <AlarmId> non défini).