Progress.GetTotalSteps

Declaration

public static int GetTotalSteps(int id);

Parameters

id The progress indicator's unique ID.

Returns

int The number of steps.

Description

Gets the total number of steps, from start to finish, for a progress indicator.

Returns -1 if you don't use steps to report progress on this indicator. To set the type of steps that the progress window displays, use Progress.SetStepLabel.

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


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