ProgressBar_AddMilestone
int ProgressBar_AddMilestone (int panel, int progressBarCtrl, double percentage);
Purpose
Adds a milestone to the progress bar.
LabWindows/CVI inserts the new milestone in the milestone list of the control according to the order determined by its percentage value.
You cannot call this function when a session is active.
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. |
| percentage | double | The percentage value of the new milestone. You must specify a double-precision value greater than 0.0 and no greater than 100.0. You cannot add a milestone with a percentage value identical to that of an existing milestone. |
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_AddMilestone function.