DlgProgressBar.GetRange

table DlgProgressBar.GetRange ( 

number ControlID )

Description

Returns a table containing the range of the progress bar control on the current screen.

Note: This action will only work if called from a screen's events and if the named control is on the current screen.

Parameters

ControlID

(number) The numeric ID of the progress bar whose range you want.

Returns

(table) A table containing the control range values indexed by the following categories:

KEY

TYPE

DESCRIPTION

Begin

number

The beginning of the progress meter range. You can access this value using tb.Begin.

End

number

The end of the progress meter range. You can access this value using tb.End.

If the current screen does not contain the control, this action will fail. If this action fails, nil is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

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

See also:  Related Actions