Admin Production ni-theme
Current Publication

ProgressBar_GetPercentage

LabWindows/CVI

ProgressBar_GetPercentage

int ProgressBar_GetPercentage (int panel, int progressBarCtrl, double *percentage);

Purpose

Returns the position of the progress bar, as a percentage.

If the progress bar is in marquee mode, you can still set and get the position of the progress bar, although that position is not indicated by the 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.
Output
Name Type Description
percentage double The position of the progress bar, as a percentage.

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