Progress.GetCurrentPos

OverviewExamples

number Progress.GetCurrentPos (

string ObjectName )

Description

Returns the current position of the progress meter within the progress bar.

Parameters

ObjectName

(string) The name of the progress object.

Returns

(number) The current position of the progress meter within the progress bar. If an error occurs -1 is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.