Ets_Progress_Bar_Handle_Progress_Set()
Abstract
Sets a progress bar to a specific progress value.
Syntax
Ets_Progress_Bar_Handle_Progress_Set (progress_bar, progress)
| Argument | Type | Description |
|---|---|---|
progress_bar |
EtsT_Progress_Bar_Handle |
Progress bar of interest. |
progress |
int |
New progress amount. |
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 sets a progress bar to a specific value, which can represent either an advance (more progress) or a retreat (less progress) relative to the current setting. progress must be in the defined range of the progress bar (zero to maximum value). If the progress bar is indeterminate, the barber pole pattern will be shifted (thus animating the bar); the value of progress 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.