Ets_Progress_Bar_Handle_Reset()
Abstract
Resets an open progress bar.
Syntax
Ets_Progress_Bar_Handle_Reset (progress_bar, title, max_value, options)
| Argument | Type | Description |
|---|---|---|
progress_bar |
EtsT_Progress_Bar_Handle |
Progress bar to reset. |
title |
const char * |
New title for the progress bar. |
max_value |
int |
New maximum value for the progress bar. |
options |
int |
Bitwise OR of possible options for the progress bar (see Details), or 0 if none. |
Return Type
void
No return value.
Header
ets_api_pbar.h
Details
This function redisplays a progress bar after resetting its current progress to zero. It also sets new values for the title, maximum value, and options (abortable status) of the progress bar.
If max_value is ETSC_PROGRESS_BAR_INDETERMINATE, the progress bar is redisplayed with a barber pole pattern and no maximum value. This can be used to display a progress bar while the scope of an operation is being determined.
If options contains EtsC_Progress_Bar_Abortable, the progress bar will have an active Cancel button.