VeriStand .NET API Reference

Table of Contents

IAlarmManager2.GetMultipleAlarmsData Method (String, String[], UInt32, AlarmInfo[])

Download PDF
Selected SectionSelected Section and Subsection(s)Entire Manual
Gets information for multiple alarms running on the specified target.

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 GetMultipleAlarmsData ( _
	target As String, _
	alarmNames As String(), _
	timeout As UInteger, _
	<OutAttribute> ByRef alarmInfo As AlarmInfo() _
) As Error
C#
Error GetMultipleAlarmsData(
	string target,
	string[] alarmNames,
	uint timeout,
	out AlarmInfo[] alarmInfo
)
Visual C++
Error^ GetMultipleAlarmsData(
	String^ target, 
	array<String^>^ alarmNames, 
	unsigned int timeout, 
	[OutAttribute] array<AlarmInfo^>^% alarmInfo
)

Parameters

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

See Also

Previous

No previous section

Next

No next section

Previous

No previous section

Next

No next section

Log in to get a better experience

Log in