ProgressBar_End
int ProgressBar_End (int panel, int progressBarCtrl, double *totalTime, char *label);
Purpose
Ends the current progress bar session.
When you call this function, the progress bar sets its position to 100, resets the current milestone, measures the actual elapsed time, and optionally uses the elapsed time to adjust the total time estimate and the position or speed of each milestone.
Parameters
| Input | ||
| Name | Type | Description |
| panel | int | The specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel. |
| progressBarCtrl | int | The ID you specified as the slideCtrl parameter in the ProgressBar_ConvertFromSlide function call or the ID returned by the ProgressBar_Create function. |
| label | char * | You can optionally pass a new label for the control that is suitable to its new position. Pass 0 to leave the label unchanged. |
| Output | ||
| Name | Type | Description |
| totalTime | double | The total amount of time elapsed since the start of the session. You can pass NULL if you do not need this value. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. Call the GetGeneralErrorString toolbox function to get a descriptive error message. |
Additional Information
Library: Progress Bar Control
Include file: custctrl\progressbar.h
LabWindows/CVI compatibility: LabWindows/CVI 2009 and later
Example
Refer to userint\custctrl\progressbar\progressdemo.cws for an example of using the ProgressBar_End function.