Teledyne LeCroy SierraFC Automation API - Manual (Page 12)

LeCroy Corporation SierraFC M8-4 API Reference Manual Manual Version 1.00
12
3.1.3 IFCAnalyzer::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
_IFCAnalyzerEvents interface).
The recording options file is the file with extension .rec created by the SierraFC Protocol
Analyzer application. You can create this file when you select ―Setup –> Recording Options…‖
from the SierraFC Protocol Analyzer application menu, change the recording options in the
―Recording Options‖ dialog, 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>