Returns alarm information for the shared variables you specify.


icon

Inputs/Outputs

  • c1dgenclassrntag.png shared variables —

    shared variables is the list of shared variables for which you want to read alarm information.

    Note
    • To read a user-defined alarm, specify the shared variable in the format \\computer\process\UserDefinedAlarm.
    • If you specify the URL of a target computer, folder, or process for shared variables, the Read Alarms VI returns alarm information for all shared variables on that computer, under that folder or process. To return all alarm information for all shared variables on the localhost, you can specify shared variables as \\localhost. To read alarm information for all shared variables under a process on the computer, you can specify shared variables as \\computer\process.
  • ci32.png timeout (s) —

    timeout specifies the maximum time, in seconds, that this VI waits for reading data from the Shared Variable Engine (SVE). The default is 5. A timeout value of less than or equal to 0 specifies no timeout, which means this VI waits indefinitely until this VI receives data from the SVE.

  • cerrcodeclst.png error in (no error) —

    error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

  • i1dcclst.png alarms —

    alarms is the alarm information for the specified shared variables.

    An event is a type of alarm that occurs instantaneously. An event is virtually any instantaneous activity such as a mouse click, whereas an alarm typically denotes an abnormal condition, occurs under certain specific conditions, or must be acknowledged by the user or configured for automatic acknowledgment. The Read Alarms VI and Read Events VI use the same outputs when returning information about alarms and events.

  • istr.png alarm URL —

    alarm URL returns the name of the alarm.

  • iatrn.png set time —

    set time returns the time that the alarm occurred.

  • istr.png set user —

    set user returns the user who was logged in when the alarm activated.

  • iatrn.png ack time —

    ack time returns the time that the alarm was acknowledged.

  • istr.png ack user —

    ack user returns the user who acknowledged the alarm.

  • iatrn.png clear time —

    clear time returns the time that the alarm was cleared.

  • istr.png clear user —

    clear user returns the user who cleared the alarm.

  • idbl.png setpoint —

    setpoint returns the value of the shared variable at the time when the alarm occurred.

  • idbl.png value —

    value returns the shared variable value when it changes alarm states. The shared variable value updates only when the shared variable changes alarm states and is not necessarily the most recent alarm value.

  • iu32.png priority —

    priority returns the priority level of the alarm.

  • istr.png alarm area —

    alarm area returns the alarm group, or area, to which the alarm belongs.

  • istr.png alarm description —

    alarm description returns a description of the alarm or event.

  • istr.png ack comment —

    ack comment returns the message the ack user entered when the user acknowledged the alarm.

  • ibool.png event? —

    event? returns TRUE if the alarm is an event.

  • iu64.png Refnum —

    alarms is the alarm information for the specified shared variables. An event is a type of alarm that occurs instantaneously. An event is virtually any instantaneous activity such as a mouse click, whereas an alarm typically denotes an abnormal condition, occurs under certain specific conditions, or must be acknowledged by the user or configured for automatic acknowledgment. The Read Alarms VI and Read Events VI use the same outputs when returning information about alarms and events.

  • ierrcodeclst.png error out —

    error out contains error information. This output provides standard error out functionality.

    • Examples

    Refer to the DSC Alarms Demo.lvproj in the labview\examples\lvdsc\Data and Alarm Historical Logging\DSC Alarms Demo directory for an example of using the Read Alarms VI.