Itrace::exporttoexcel – Teledyne LeCroy SAS_SATA Automation API manual User Manual

Page 70

Advertising
background image

Teledyne LeCroy

SASTrace Object

64

Automation API for Teledyne LeCroy SAS/SATA Protocol Suite

ITrace::ExportToExcel

HRESULT ExportToExcel (

[in] BSTR file_name,

[in] VIEW_TYPE export_view_type,

[in] long from_row,
[in] long to_row);

Exports Spreadsheet View and Frame View to an Excel 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 an Excel file. If the 

display options apply to this trace, then hidden packets are not exported.

If the packet range specified is invalid, then the packet range is adjusted automatically.

Example

See ExportToText example.

Advertising