VeriStand .NET API Reference

IChannelFault.GetFaultValue Method

Gets the software fault value of a specified channel.

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 GetFaultValue ( _
	channelName As String, _
	<OutAttribute> ByRef faulted As Boolean, _
	<OutAttribute> ByRef value As Double _
) As Error
C#
Error GetFaultValue(
	string channelName,
	out bool faulted,
	out double value
)
Visual C++
Error^ GetFaultValue(
	String^ channelName, 
	[OutAttribute] bool% faulted, 
	[OutAttribute] double% value
)

Parameters

channelName
Type: System.String
The channel from which to get the fault value. You must enter the full path to the channel, for example:

Targets/Controller/Simulation Models/Models/delay_random/Inports/In1

faulted
Type: System.Boolean %
Indicates whether the specified channel is faulted. TRUE indicates the channel is faulted.
value
Type: System.Double %
The fault value of the specified channel. If the specified channel is not a faulted channel, this parameter returns 0.

Return Value

Returns an Error object. If the software faulting component is not available or the channel is not faultable, the Code property of the Error object contains an error number. If no error occurs, the Code property of the Error object is 0.

See Also

Log in to get a better experience