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

28
FireInspector Automation User’s Manual CATC Version 1.0
2.4.2 ITrace::ApplyDisplayOptions
Applies specified display options to the trace.
Syntax
HRESULT ApplyDisplayOptions (
[in] BSTR do_file_name );
Parameters
• do_file_name – string providing the full pathname to display options file
Return values
• ANALYZERCOMERROR_UNABLELOADDO – unable to load display options file
Remarks
Use this method if you want to filter traffic of some type in the recorded or opened trace.
Display options file is the file with extension .opt created by FireInspector application.
You can create such file when you select Setup > Display Options… from FireInspector
application menu, change the display options in the appeared dialog and select “Save…”
button.
Example
WSH:
Set Analyzer = WScript.CreateObject("CATC.FwAnalyzer")
CurrentDir = Left(WScript.ScriptFullName,
InstrRev(WScript.ScriptFullName, "\"))
Set Trace = Analyzer.MakeRecording (CurrentDir &
"Input\test_ro.rec")
Trace.ApplyDisplayOptions CurrentDir &
"Input\test_do.opt"
Trace.Save CurrentDir &
"Output\saved_file.fdb"
C++:
IFwTrace* fw_trace;
TCHAR file_name[_MAX_PATH];
. . .
try
{
fw_trace->ApplyDisplayOptions( file_name );
}
catch ( _com_error& er)
{
if (er.Description().length() > 0)
::MessageBox( NULL, er.Description(), _T("FwAnalyzer
client"), MB_OK );
else
::MessageBox( NULL, er.ErrorMessage(), _T("FwAnalyzer
client"), MB_OK );
return 1;
}