Teledyne LeCroy USB Analyzer Automation Manual - Manual (Page 27)

Teledyne LeCroy Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol
Suite
27
2.1.14 IUsbAnalyzer::StartUsb3Generation
HRESULT StartUsb3Generation([ in , defaultvalue ("")] BSTR gen_file_name);
Starts generating USB traffic.
Parameters
gen_file_name USB 3.0 Exerciser script file name to execute.
If this parameter is an empty string, the last executed
script is repeated.
Return values
ANALYZERCOMERROR_ANALYZERNOTCONNECTED No Analyzer connected
ANALYZERCOMERROR_UNABLESTARTGENERATION
Analyzer cannot start for one of
the following reasons:
- Script has compiling error.
- Analyzer is currently running or paused.
- Analyzer is currently used by another client.
- License for trainer device was not purchased.
- USB 2.0 generation is running.
Remarks
This function returns after generation starts. Analyzer continues generating until it finishes or until the
StopUsb3Generation or PauseUsb3Generation method call is performed.
During generation, events are sent to the event sink (see the
_IAnalyzerEvents interface section).
The script file should have the f
ile extension “.usb3g”. It can be created by either the USB Protocol Suite
text editor or any plain-text editor.