ProgressBar_Abort
int ProgressBar_Abort (int panel, int progressBarCtrl, int fillToEnd, char *label);
Purpose
Aborts the current progress bar session.
This function ends the current session without adjusting the total time estimate or the milestones.
If fillToEnd is TRUE, the color of the progress bar changes to the color you defined using the ATTR_PROGRESSBAR_BAR_ABORT_COLOR attribute.
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. |
| fillToEnd | int | Pass TRUE if you want to set the progress bar position to 100 using the abort color. Pass FALSE if you want to set the progress bar position to 0. |
| 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. |
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