Admin Production ni-theme
Current Publication

ProgressBar_Pause

LabWindows/CVI

ProgressBar_Pause

int ProgressBar_Pause (int panel, int progressBarCtrl, char *label);

Purpose

Pauses the current progress bar session.

While the session is paused, the progress bar does not advance, and the time elapsed is not included in the total amount of time of the task.

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.
label char * You can optionally pass a new label for the control that is suitable to its new position. Pass 0 to leave the label unchanged.

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