IAlarmManager.GetMultipleAlarmsData Method
- Aktualisiert2023-02-21
- 3 Minute(n) Lesezeit
This method from the IAlarmManager interface gets a list of all the alarms running on the first target. However, National Instruments recommends that you use the GetMultipleAlarmsData method of the IAlarmManager2 interface instead of this deprecated method.
Namespace:
NationalInstruments.VeriStand.ClientAPIYou must use the GetMultipleAlarmsData method of the IAlarmManager2 interface if you want to specify one of multiple targets.
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
| Visual Basic (Declaration) |
|---|
Function GetMultipleAlarmsData ( _ alarmNames As String(), _ timeout As UInteger, _ <OutAttribute> ByRef alarmInfo As AlarmInfo() _ ) As Error |
| C# |
|---|
Error GetMultipleAlarmsData( string[] alarmNames, uint timeout, out AlarmInfo[] alarmInfo ) |
| Visual C++ |
|---|
Error^ GetMultipleAlarmsData( array<String^>^ alarmNames, unsigned int timeout, [OutAttribute] array<AlarmInfo^>^% alarmInfo ) |
Parameters
- alarmNames
- Type:
System.String
Specifies the names of the alarms for which you want to get information.
- timeout
- Type: System.UInt32
Specifies the time, in milliseconds, for this method to attempt to read data from the alarm manager before returning an error.
- alarmInfo
- Type:
NationalInstruments.VeriStand.ClientAPI.AlarmInfo
%
Returns the alarm information. Use this parameter with the properties of the AlarmInfo class to get specific information about an alarm, such as its high limit, low limit, mode, priority, and state.
Return Value
Returns an Error object. If no error occurs, the Code property of the Error object is 0.
Remarks
This method is deprecated in NI VeriStand 2010 and later.