Ets_Progress_Bar_Abortable_Start()
Abstract
Creates a progress bar that contains a Cancel button.
Syntax
Ets_Progress_Bar_Abortable_Start (title, max)
| Argument | Type | Description |
|---|---|---|
title |
char * |
textual title of the progress bar |
max |
int |
maximum value of the progress bar range |
Return Type
void
No return value.
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_Start() with the options argument set to EtsC_Progress_Bar_Abortable.
If a lengthy operation is being performed, it is useful to keep the user informed of the progress with a progress bar. If there is a chance the user may not want to continue the process, the Cancel button allow the user to stop the process before its completion.
This function sets the title and range of the progress bar displayed on the screen. The progress bar will be accompanied by a Cancel button, which allows the user to halt the progress of the process whose progress is being shown. If a progress bar is already displayed, it will be reset to its initial position.
If the user should not be able to cancel the process once it has started, use Ets_Progress_Bar_Start() instead of this function, so that the progress bar is not abortable.