Ets_Progress_Bar_Advance()
Abstract
Changes the current setting shown on the progress bar.
Syntax
Ets_Progress_Bar_Advance (delta)
| Argument | Type | Description |
|---|---|---|
delta |
int |
amount to be added to the current progress bar |
Return Type
int
EtsC_True if the progress bar is abortable and the user has pressed the Cancel button; EtsC_False otherwise.
Header
ets_api_pbar.h
Details
Note: This function is part of the original progress bar API (release 10.5 and earlier). For new code, use Ets_Progress_Bar_Handle_Advance().
This function extends the progress bar by the amount specified relative to the range’s maximum value. If the progress bar is an abortable bar, it also checks whether the user has pressed the Cancel button since the last progress bar update.
If the progress bar was created with Ets_Progress_Bar_Abortable_Start(), it will contain a Cancel button to allow the user to cancel the operation. If so, this function returns EtsC_True if the Cancel button has been pressed since the last time the progress bar was advanced.