ProgressBar_GetCurrentMilestoneIndex
int ProgressBar_GetCurrentMilestoneIndex (int panel, int progressBarCtrl, size_t *milestoneIndex);
Purpose
Returns the index of the last milestone to which you advanced the progress bar.
If you have not advanced to any milestone in the current session or if there are no milestones specified in the progress bar, the function returns 0.
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. | ||
| Output | ||||
| Name | Type | Description | ||
| milestoneIndex | size_t | One-based index representing the 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