OseGetFlowsCommand Object


Description:

Retrieve OSE flows.

Can be used with Command Sequencer: Yes

GUI Command Name: OSE: Get OSE Flows

Parents: Sequencer, StcSystem

OseGetFlowsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
ExportFilePath

Target path to which to save the file.

Type: string

Default: OSE_Flows_

SwitchBlockHandleList

Switch blocks for which to retrieve the flows.

Type: handle

Default: 0

OseGetFlowsCommand Read-Only Attributes

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

Status of the flow export to file action.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Export successful.

FALSE

Export was not successful.

FlowsDump

Displays the flows in text format.

Type: string

Default: "" (empty string)