Progress.GetCurrentStep

Declaration

public static int GetCurrentStep(int id);

Parameters

id The progress indicator's unique ID.

Returns

int The current step.

Description

Gets the current step for a progress indicator.

Returns -1 if the indicator is not set to report progress in steps. To set the type of steps that the progress window displays, use Progress.SetStepLabel.

Additional resources: Progress.Report, Progress.GetTotalSteps, Progress.GetStepLabel, Progress.SetStepLabel.


Did you find this page useful? Please give it a rating: