Ets_Progress_Bar_Handle_Start()
Abstract
Creates a new progress bar.
Syntax
Ets_Progress_Bar_Handle_Start (title, max_value, options)
| Argument | Type | Description |
|---|---|---|
title |
const char * |
Title for the progress bar. |
max_value |
int |
Maximum value for the progress bar (see Details). |
options |
int |
Bitwise OR of possible options for the progress bar (see Details), or 0 if none. |
Return Type
EtsT_Progress_Bar_Handle
Handle to the new progress bar.
Header
ets_api_pbar.h
Details
This function opens a new progress bar with the specified title and range, with a current progress of zero.
If max_value is ETSC_PROGRESS_BAR_INDETERMINATE, the progress bar will open 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.
This function replaces the older functions Ets_Progress_Bar_Start() and Ets_Progress_Bar_Abortable_Start().