GETSTEP function

Synopsis

This function returns a step object. Given a flowchart name and step name (as a string), GETSTEP returns the corresponding step object, which can then be used in links to reference the named step.

Remarks

You can use this function to translate a choice made in the operator view (for example, from a dropdown list) into a step reference. This allows for one set of operator view controls to be applied to different steps in the flowchart.
You can view the template projects for example use cases of the GETSTEP function.

Variations

GETSTEP(FlowchartName, StepName)

Specifies the step object to return.

Details | Examples | Details and examples

Parameters

FlowchartName

Specifies the name of the flowchart.

Supported types: String.

StepName

Specifies the name of the step.

Supported types: String.

Returns

Returned types: Step.

Examples

1.	The following example returns the specified step. GETSTEP("MainFlowchart", Flowcharts("MainFlowchart").Variables.SelectedStepName)