Teledyne LeCroy SAS_SATA Automation API manual - Manual (Page 65)

Automation API for Teledyne LeCroy SAS/SATA Protocol Suite 59
SASTrace Object Teledyne LeCroy
ITrace::ExportToText
HRESULT ExportToText (
[in] BSTR file_name,
[in] VIEW_TYPE export_view_type,
[in] long from_row,
[in] long to_row);
Exports Spreadsheet View and Frame View 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
export_view_type VIEW_TYPE can be: COLUMN_VIEW (0), FRAME_TEXT_VIEW (1) [valid
parameter for this method], PACKET_VIEW (2), WAVEFORM_VIEW (3),
ST_REPORT_VIEW (4), SPREAD_SHEET_VIEW (5) [valid parameter for this
method], HISTOGRAM_VIEW (6), BUS_UTILIZATION_VIEW (7).
from_row Beginning packet number when you are exporting a range of packets.
1 = first packet of the exported trace is the first packet of this trace.
to_row Ending packet number when you are exporting a range of packets.
1 = 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 is adjusted automatically.
Here is a snippet of an exported text file:
File c:\analyzersw\traces\sas\allsata.sas.
From Frame #1 to Frame #20.
Frame#
_______|_______________________________________________________________________T2
Frame(1) 1.5(G) SATA RCV Time Stamp(29.196 501 432)
_______|_______________________________________________________________________T2
Frame(2) 1.5(G) SATA XMT SATA_SOF FIS Type(DMA Activate) Port(0x0)
_______| Data(4 bytes) CRC(0x8FA86FC5) SATA_EOF Time Stamp(29.196 513 752)
_______|_______________________________________________________________________I2
Frame(3) 1.5(G) SATA RCV Time Stamp(29.196 514 177)
_______|_______________________________________________________________________I2
Frame(4) 1.5(G) SATA XMT SATA_SOF FIS Type(Data) Port(0x0)