Teledyne LeCroy SAS_SATA Tracer_Trainer Automation API Manual - Manual (Page 30)

LeCroy Corporation Automation API for SAS/SATATracer/Trainer Manual Version 1.11
30
4.1.4 ITrace::ExportToText
HRESULT ExportToText (
[in] BSTR file_name,
[in, defaultvalue(-1)] long packet_from,
[in, defaultvalue(-1)] long packet_to );
Exports the trace into a text file while allowing you to specify a range of packets.
Parameters
file_name String providing the full file pathname for the exported trace
packet_from
Beginning packet number when you are exporting a range of packets,
Value –1 means that the first packet of the exported trace is the first
packet of this trace.
packet_to
Ending packet number when you are exporting a range of packets,
Value –1 means that the last packet of the exported trace is the last
packet of this trace.
Return value
ANALYZERCOMERROR_UNABLESAVE –
unable to export trace file
Remarks
Use this method if you want to export a recorded or opened trace into a text file. If the
display options apply to this trace (see
ITrace::ApplyDisplayOptions or
ISASAnalyzer::LoadDisplayOptions ), then hidden packets would not be exported.
If the packet range specified is invalid (for example packet_to is more than the last packet
number in the trace, or packet_from is less than the first packet number in the trace, or
packet_from is more than packet_to) then the packet range will be adjusted automatically.