SubscribeResultsViewCommand Object


Description:

Subscribe to a run-time Result View already defined by a Result View Template XML file.

Can be used with Command Sequencer: No

Parents: Project, Sequencer, StcSystem

SubscribeResultsViewCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
ExportFormat

Format to use for export.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

Use for getting number of rows.

CSV

Export in CSV format.

BINARY

Export in Binary format. Command will return all exported values.

FileNamePrefix

Prefix to CSV export file name.

Type: string

Default: "" (empty string)

Interval

Result update interval to override template value.

Type: u32

Default: 0

RecordsPerPage

Number of records per page to override template value.

Type: u16

Default: 0

TemplateUri

Template to be used for subscribe.

Type: string

Default: "" (empty string)

WaitTime

Wait time between subscribe results and export results to provide enough time for results to be populated.

Type: double

Default: 3.0

Range: 0.005 - 2147483647.0

SubscribeResultsViewCommand Read-Only Attributes

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

Handle to the subscribed Result View.

Type: handle

Default: 0

TableColumnCount

Number of columns for each table in TableNames.

Type: u32

Default: 0

TableColumnNames

Comma separated name of columns for each table in TableNames.

Type: string

Default: 0

TableColumnValues

Comma separated values of counters for each table in TableNames.

Type: string

Default: 0

TableNames

Names of the exported table.

Type: string

Default: 0