Teledyne LeCroy FireInspector Automation Application Programming Interface - Manual (Page 18)

14
FireInspector Automation User’s Manual CATC Version 1.0
2.3.6 IAnalyzer::StartRecording
Starts recording with specified recording options.
Syntax
HRESULT StartRecording (
[in] BSTR ro_file_name );
Parameters
• ro_file_name – string providing the full pathname to recording options file; if the
parameter is omitted then recording starts with default recording options
Return values
• ANALYZERCOMERROR_EVENTSINKNOTINSTANTIATED – event sink was not
instantiated
• ANALYZERCOMERROR_UNABLESTARTRECORDING – unable to start recording
Remarks
After recording starts this function will return. Analyzer continues recording until it is fin-
ished or until “
StopRecording ” method call is performed. During the recording the
events are send to event sink (see _IAnalyzerEvents interface).
Recording options file is the file with extension .rec created by FireInspector application.
You can create such file when you select Setup > Recording Options… from FireInspector
application menu, change the recording options in the appeared dialog and select
“Save…” button.
Example
VBScript:
<OBJECT
RUNAT=Server
ID = Analyzer
CLASSID = "clsid:0B179BC1-DC61-11D4-9B71-000102566088"
>
</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++:
IFwAnalyzer* fw_analyzer;
BSTR ro_file_name;