Isasanalyzer::startrecording – Teledyne LeCroy SAS_SATA Automation API manual User Manual

Page 20

Advertising
background image

Teledyne LeCroy

SASAnalyzer Object

14

Automation API for Teledyne LeCroy SAS/SATA Protocol Suite

ISASAnalyzer::StartRecording

HRESULT StartRecording (
[in] BSTR ro_file_name );

Starts recording with specified recording options.

Parameters

ro_file_name

String providing the full pathname to the recording options file. If the 

parameter is omitted, then recording starts with default recording 
options.

Return Values

ANALYZERCOMERROR_UNABLESTARTRECORDING Unable to start recording

Remarks

After recording starts, this function will return. The Analyzer continues recording until it is 
finished or until the StopRecording method call is performed. During recording, events 
are sent to the event sink (see the 

ISASAnalyzer Interface

).

The recording options file is the file with extension .sac created by the SAS/SATA 
Protocol Suite application. You can create this file when you select File –> Protocol 
Analyzer…
 from the SAS Protocol Suite application menu, change the recording options in 
the Protocol Analyzer project, and select the Save… button.

Example

VBScript:

<OBJECT
RUNAT=Server
ID = Analyzer
CLASSID = " clsid: 297CD804-08F5-4A4F-B3BA-779B2654B27C

"

>
</OBJECT>

<INPUT TYPE=TEXT VALUE="" NAME="TextRecOptions">

<SCRIPT LANGUAGE="VBScript">
<!--
Sub BtnStartRecording_OnClick
On Error Resume Next
Analyzer.StartRecording TextRecOptions.value
If Err.Number <> 0 Then
MsgBox Err.Number & ":" & Err.Description
End If
End Sub
-->
</SCRIPT>
C++:

Advertising