You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.6 Datalogging and Supervisory Control Module Help

Owning Palette: Alarms & Events VIs

Installed With: DSC Module

Returns alarm information for the shared variables you specify.

	shared variables is the list of shared variables for which you want to read alarm information.
	timeout limits the time that the VI waits for data to be returned from the database. A timeout value of less than or equal to 0 indicates no timeout. The VI waits indefinitely until the data is returned.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	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. alarm URL returns the name of the alarm. event? returns TRUE if the alarm is an event. set time returns the time that the alarm occurred. ack time returns the time that the alarm was acknowledged. clear time returns the time that the alarm was cleared. setpoint returns the value of the shared variable at the time when the alarm occurred. 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. priority returns the priority level of the alarm. alarm area returns the alarm group, or area, to which the alarm belongs. alarm description returns a description of the alarm or event. ack comment returns the message the ack user entered when the user acknowledged the alarm. set user returns the user who was logged in when the alarm activated. ack user returns the user who acknowledged the alarm. clear user returns the user who cleared the alarm.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.