VeriStand .NET API Reference

Table of Contents

IAlarm.GetAlarmData Method

Download PDF
Selected SectionSelected Section and Subsection(s)Entire Manual
Accesses information about an alarm.

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 GetAlarmData ( _
	<OutAttribute> ByRef alarmData As AlarmInfo, _
	timeout As UInteger _
) As Error
C#
Error GetAlarmData(
	out AlarmInfo alarmData,
	uint timeout
)
Visual C++
Error^ GetAlarmData(
	[OutAttribute] AlarmInfo^% alarmData, 
	unsigned int timeout
)

Parameters

alarmData
Type: NationalInstruments.VeriStand.ClientAPI.AlarmInfo %
Returns data for an alarm. Use this parameter with the properties of the AlarmInfo class to get specific information about the alarm, such as its high limit, low limit, mode, priority, and state.
timeout
Type: System.UInt32
Specifies the time in milliseconds to attempt to read data from the alarm before returning an error.

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