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

Returns a summary of the alarms associated with shared variables and filtered by read parameters.

	shared variables is the list of shared variables for which you want alarm status.
	read parameters is a cluster of options for filtering out alarms. Min priority is the minimum priority of alarms to read. If you do not wire a value to Min priority, this VI reports alarms corresponding to priority level 1 and above. Max priority is the maximum priority of alarms to read. If you do not wire this parameter, the VI reports alarms corresponding to priority level 1,000 and below. Show Acknowledged alarms? determines whether this VI reads acknowledged alarms.
	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.
	alarm summary data is the summary of the alarms for the specified shared variables. # active alarms occurrences is the number of alarms occurrences currently in the system. # unack alarms occurrences is the number of unacknowledged alarms in the system. # shared variables with active alarms is the number of shared variables with active alarms. # shared variables with unack alarms is the number of shared variables with unacknowledged alarms. any alarm occurrences? is an indication of any shared variable in the system being in alarm, regardless of its acknowledgment status. any alarm occurrences? and any shared variables with alarms? return the same information. any unack alarm occurrences? is an indication of any shared variable in the system being in alarm and unacknowledged. any unack alarm occurrences? and any shared variables with unack alarms? return the same information. any shared variables with alarms? is an indication of shared variables being in alarm. any alarm occurrences? and any shared variables with alarms? return the same information. any shared variables with unack alarms? is an indication of any shared variables with unacknowledged alarms. any unack alarm occurrences? and any shared variables with unack alarms? return the same information.
	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.