Sets 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 SetFaultValue ( _
channelName As String, _
value As Double _
) As Error |
| Visual C++ |
|---|
Error^ SetFaultValue(
String^ channelName,
double value
) |
Parameters
- channelName
- Type: System.String
The channel for which to set the fault value. You must enter the full path to the channel, for example:
Targets/Controller/Simulation Models/Models/delay_random/Inports/In1
- value
- Type: System.Double
The fault value.
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.
