ProgressBar_GetMilestone
int ProgressBar_GetMilestone (int panel, int progressBarCtrl, size_t milestoneIndex, double *percentage);
Purpose
Returns the position of a milestone in the progress bar, as a percentage.
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. | ||
| milestoneIndex | size_t | One-based index representing the milestone.
|
||
| Output | ||||
| Name | Type | Description | ||
| percentage | double | The current position of the milestone, as a percentage. This value might not be the same as when the milestone was first defined, if you enable auto adjust and the adjustment type is VAL_PROGRESSBAR_ADJUST_RATE. |
||
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_GetMilestone function.