VeriStand .NET API Reference

IAlarmManager2.GetAlarmsStatus Method (String, Boolean, Boolean, Boolean, String, String, String)

NOTE: This method is obsolete.

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

Gets the status of the high, medium, and low-priority alarms running on the first target. However, 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)
<ObsoleteAttribute("Obsolete. Strict priorities of low, medium, and high are no longer supported. Valid priorities now range from 0 - 31. This function will only test alarms in group 0.")> _
Function GetAlarmsStatus ( _
	target As String, _
	<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#
[ObsoleteAttribute("Obsolete. Strict priorities of low, medium, and high are no longer supported. Valid priorities now range from 0 - 31. This function will only test alarms in group 0.")]
Error GetAlarmsStatus(
	string target,
	out bool highAlarm,
	out bool medAlarm,
	out bool lowAlarm,
	out string highAlarmName,
	out string medAlarmName,
	out string lowAlarmName
)
Visual C++
[ObsoleteAttribute(L"Obsolete. Strict priorities of low, medium, and high are no longer supported. Valid priorities now range from 0 - 31. This function will only test alarms in group 0.")]
Error^ GetAlarmsStatus(
	String^ target, 
	[OutAttribute] bool% highAlarm, 
	[OutAttribute] bool% medAlarm, 
	[OutAttribute] bool% lowAlarm, 
	[OutAttribute] String^% highAlarmName, 
	[OutAttribute] String^% medAlarmName, 
	[OutAttribute] String^% lowAlarmName
)

Parameters

target
Type: System.String
Specifies the name of the target to query.
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