VeriStand .NET API Reference

IAlarmManager.GetAlarmsStatus Method

This method is obsolete in NI VeriStand 2011 and later. Use the GetMultipleAlarmsData method of the IAlarmManager2 interface instead, which allows you to get specific information about an alarm, such as its status.

Strict priorities of low, medium, and high are no longer supported. Valid priorities now range from 0 - 31. This method only tests alarms in group 0.

Namespace: NationalInstruments.VeriStand.ClientAPI
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
Visual Basic (Declaration)
Function GetAlarmsStatus ( _
	<OutAttribute> ByRef highAlarm As Boolean, _
	<OutAttribute> ByRef medAlarm As Boolean, _
	<OutAttribute> ByRef lowAlarm As Boolean, _
	<OutAttribute> ByRef highAlarmName As String, _
	<OutAttribute> ByRef medAlarmName As String, _
	<OutAttribute> ByRef lowAlarmName As String _
) As Error
C#
Error GetAlarmsStatus(
	out bool highAlarm,
	out bool medAlarm,
	out bool lowAlarm,
	out string highAlarmName,
	out string medAlarmName,
	out string lowAlarmName
)
Visual C++
Error^ GetAlarmsStatus(
	[OutAttribute] bool% highAlarm, 
	[OutAttribute] bool% medAlarm, 
	[OutAttribute] bool% lowAlarm, 
	[OutAttribute] String^% highAlarmName, 
	[OutAttribute] String^% medAlarmName, 
	[OutAttribute] String^% lowAlarmName
)

Parameters

highAlarm
Type: System.Boolean %
Returns TRUE if a high-priority alarm is triggered.
medAlarm
Type: System.Boolean %
Returns TRUE if a medium-priority alarm is triggered.
lowAlarm
Type: System.Boolean %
Returns TRUE if a low-priority alarm is triggered.
highAlarmName
Type: System.String %
Returns the name of the currently active, high-priority alarm.
medAlarmName
Type: System.String %
Returns the name of the currently active, medium-priority alarm.
lowAlarmName
Type: System.String %
Returns the name of the currently active, low-priority alarm.

Return Value

Returns an Error object. If no error occurs, the Code property of the Error object is 0.

See Also

Log in to get a better experience