Ets_Progress_Bar_Handle_Advance()
Abstract
Changes the current setting shown on the progress bar.
Syntax
Ets_Progress_Bar_Handle_Advance (progress_bar, delta)
| Argument | Type | Description |
|---|---|---|
progress_bar |
EtsT_Progress_Bar_Handle |
Progress bar to be advanced. |
delta |
int |
Amount to advance the progress bar. |
Return Type
int
EtsC_True if the progress bar is abortable and the user has clicked the Cancel button; EtsC_False otherwise.
Header
ets_api_pbar.h
Details
This function adjusts the current progress setting of the specified progress bar by the amount delta. A positive delta will lengthen the progress bar and a negative delta will shorten it. If the progress bar is indeterminate, the barber pole pattern will be shifted (thus animating the bar); the value of delta in this case is unimportant.
If the progress bar is abortable, this function also checks whether the user has pressed the Cancel button since the last progress bar update.
This function replaces the older function Ets_Progress_Bar_Advance().