VeriStand .NET API Reference

IAlarm.SetEnabledState Method

Enables or disables the current 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 SetEnabledState ( _
	enabled As Boolean _
) As Error
C#
Error SetEnabledState(
	bool enabled
)
Visual C++
Error^ SetEnabledState(
	bool enabled
)

Parameters

enabled
Type: System.Boolean
Specifies the state of the alarm. A TRUE value enables the alarm. A FALSE value disables the alarm.

Return Value

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

See Also