Teledyne LeCroy Automation API for Teledyne LeCroy PETracer_PETrainer - Manual (Page 37)

Teledyne LeCroy Automation API for PETracer/PETrainer
32
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 values
ANALYZERCOMERROR_UNABLESAVE Unable to export trace file
Remarks
Use this method if you want to export a recorded or an opened trace into a text file. If the display options
applied to this trace (see ITrace::ApplyDisplayOptions on Page 27 or IAnalyzer::LoadDisplayOptions on Page
14), then hidden packets would not be exported.
If the packet range is specified and it 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 packet range is adjusted automatically.