Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Alarms & Events VIs

Owning Palette: DSC Module VIs and Functions

Installed With: DSC Module. This topic might not match its corresponding palette in LabVIEW depending on your operating system, licensed product(s), and target.

Use the Alarms & Events VIs to acknowledge alarms, display alarm summary or event history information, or obtain alarm summary status.

The VIs on this palette can return general LabVIEW error codes or specific DSC Module error codes.

Palette ObjectDescription
Acknowledge AlarmsAcknowledges alarms by shared variable name, by alarm, or by alarm area. Use this VI to acknowledge alarm occurrences for the specified shared variable. You must manually select the polymorphic instance to use.
Alarm StatusReturns a summary of the alarms associated with shared variables and filtered by read parameters.
Cancel Alarm & Event NotificationsStops alarm and event notifications for the specified shared variables.
Cancel System Event NotificationsStops system event notifications for the specified server.
Clear User Defined AlarmClears an alarm you create using the Set User Defined Alarm VI. If you specify an alarm not created using the Set User Defined Alarm VI, this VI returns an error.
Disable Alarm & Event NotificationsReleases an event reference created by the Enable Alarm & Event Notifications VI and cleans up all resources associated with the event. Any Event Structures registered for this event stop receiving alarm and event notifications.
Enable Alarm & Event NotificationsReturns a reference to a user event that you can use to monitor alarms and events. Wire the alarm & event notification input to the Request Alarm & Event Notifications VI or the Request System Event Notifications VI to select alarm and event data sources to monitor. Wire the alarm & event notification input to the Register for Events function to register the event for use with an Event Structure. Wire the alarm & event notification input to the Disable Alarm & Event Notifications VI to stop receiving notifications and clean up all resources associated with this event.
Read AlarmsReturns alarm information for the shared variables you specify.
Read EventsReturns event information compiled from all machines from which you have previously read an alarm or event.
Request Alarm & Event NotificationsSubscribes to alarm and event data for the specified shared variables and begins generating notification events. Call this VI multiple times to add to the list of shared variables you want to monitor for alarm and event changes.
Request System Event NotificationsSubscribes to status updates from the Shared Variable Engine running on the specified server and begins generating alarm and event notifications. Call this VI multiple times to subscribe to additional servers.
Set User Defined AlarmCreates an alarm that is not associated with a shared variable. You must clear the existing alarm before you can set the alarm again. Use the Clear User Defined Alarm VI to clear the alarm. LabVIEW automatically clears all alarms created using this VI when LabVIEW shuts down.
Set User Defined EventCreates an event that is not associated with a shared variable.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit