Teledyne LeCroy SAS_SATA Automation API manual - Manual (Page 48)

Teledyne LeCroy SASAnalyzer Object
42 Automation API for Teledyne LeCroy SAS/SATA Protocol Suite
ISASAnalyzer ::SetVSELogToSaveAutomatically
HRESULT SetVSELogToSaveAutomatically (
[in] BOOL bSaveAutomatically,
[out,retval] BOOL *pResult);
This function sets the flag for automatically saving, or not saving, VSE log files.
Parameters
bSaveAutomatically TRUE = Saves the log file automatically after a VSE
script run.
FALSE = Does not save the log file after a VSE
script run.
Return Values
pResult TRUE = Flag set successfully.
FALSE = Could not set the flag.
Remarks
Default value is retrieved from the VSE settings. Note that, after installation, the VSE
settings have no value for the flag. To have a default value, you must enter the value
manually in the VSE settings.
Before using this command to automatically save log files, you must make sure that the
VSE settings have the path to the folder in which to save log files. Note that, after
installation, the VSE settings have no value for the path. To set the path, you can enter
the value manually in the VSE settings. Alternatively, before calling this function, you can
run the SetVSELogModeToMultipleFile command to set the folder path.
If the SetVSELogToSaveAutomatically function parameter is set to FALSE, the system
does not save any log files, regardless of any other method settings.
Example
VBScript:
Analyzer.SetVSELogToSaveAutomatically(1)
Analyzer.SetVSELogToSaveAutomatically(0)