ExportResultsCommand Object


Description:

Exports results of an existing Result View to a file.

Tcl example:

stc::perform ExportResults -filenameprefix myresults -resultview [ stc::get
                project1 -children-resultdataset ]

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Export Results

Parents: Sequencer, StcSystem

ExportResultsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
ColumnHeaderStyle

Style for the column heading names.

Type: enum

Default: DISPLAY

Possible Values:

Value Description
DISPLAY

Use the GUI display name for column headings.

PROPERTY

Use the property name for column headings.

FileNamePrefix

Prefix of results file.

Type: string

Default: "" (empty string)

OutputFormat

Format of results file. Currently only csv format is supported.

Type: enum

Default: CSV

Possible Values:

Value Description
CSV

CSV.

XML

XML.

ResultTab

Name of the tab on which to display the results.

Type: string

Default: "" (empty string)

ResultView

Handle to the Result View to export. Can either be a ResultDataSet or DynamicResultView. Charts are not supported.

Type: handle

Default: 0

WriteMode

Write mode for file save.

Type: enum

Default: OVERWRITE

Possible Values:

Value Description
APPEND

Append results to the end of an existing file.

OVERWRITE

Overwrite an existing file.

ExportResultsCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status
OutputResult

Output Result Information

Type: string

Default: "" (empty string)