IStimulus.RunStimulusProfile Method
- Updated2023-02-21
- 3 minute(s) read
This method is deprecated in NI VeriStand 2010 and later. Use the RunStimulusProfile instance in the IStimulus2 interface instead.
Namespace:
NationalInstruments.VeriStand.ClientAPIRuns a stimulus profile and logs data to a TDMS file in the directory you specify.
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
| Visual Basic (Declaration) |
|---|
Function RunStimulusProfile ( _ file_path As String, _ base_log_path As String, _ timeout As UInteger, _ auto_start As Boolean, _ stop_on_disconnect As Boolean _ ) As Error |
| C# |
|---|
Error RunStimulusProfile( string file_path, string base_log_path, uint timeout, bool auto_start, bool stop_on_disconnect ) |
| Visual C++ |
|---|
Error^ RunStimulusProfile( String^ file_path, String^ base_log_path, unsigned int timeout, bool auto_start, bool stop_on_disconnect ) |
Parameters
- file_path
- Type: System.String
The path to the stimulus profile file.
- base_log_path
- Type: System.String
The directory where NI VeriStand saves the logged TDMS files for the stimulus profile. This parameter applies only to relative log file paths. If this parameter is empty, this method saves the log files in a default location.
- timeout
- Type: System.UInt32
The length of time in milliseconds to wait for the stimulus profile to start the test before the operation times out.
- auto_start
- Type: System.Boolean
Specifies whether to start running the stimulus profile file on the target as soon as the file finishes downloading. If false (False in Visual Basic), you must use an external trigger, such as a custom device, to start running the stimulus profile file on the target.
- stop_on_disconnect
- Type: System.Boolean
Specifies whether to stop running the stimulus profile file on the target when you disconnect from the target. If false (False in Visual Basic), the stimulus profile file continues running on the target after you close NI VeriStand and disconnect from the target.
Return Value
Returns an Error object. If no error occurs, the Code property of the Error object is 0.
Remarks
The method is valid for the original version of the NI VeriStand Stimulus Profile Editor only. In NI VeriStand 2011 and later, this method is maintained for compatibility purposes only. Use the members of the Stimulus Profile Execution API to interact with stimulus profiles in NI VeriStand 2011 and later.