Admin Production ni-theme
Current Publication

ProgressBar_SetMilestones

LabWindows/CVI

ProgressBar_SetMilestones

int ProgressBar_SetMilestones (int panel, int progressBarCtrl, ...);

Purpose

Creates a set of milestones for the progress bar.

When you call this function, LabWindows/CVI discards any previously defined milestones from the progress bar control.

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.
milestoneList ... A zero-terminated list of percentage values representing the percentage values of each milestone.

You cannot pass two or more milestones with the same value.

For each milestone, you can pass any double-precision value that is greater than 0.0 and less than 100.0. You do not need to enter the values in numerical order; the control sorts the values, and when you advance from milestone to milestone, the control advances through them in sorted order, regardless of the order in which you specify them.

Note that the terminating zero (0.0) must be a double-precision value.

The following example illustrates how you can use this function:

ProgressBar_SetMilestones (panel, progressBarCtrl, 25.0, 50.0, 75.0, 0.0);

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