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)
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.