Admin Production ni-theme
Current Publication

ProgressBar_GetAttribute

LabWindows/CVI

ProgressBar_GetAttribute

int ProgressBar_GetAttribute (int panel, int progressBarCtrl, int attribute, void *value);

Purpose

Obtains the value of a progress bar attribute.

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.
attribute int The progress bar control attribute value to obtain.

In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a list of the available attributes. LabWindows/CVI dims attributes whose values cannot be obtained. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>.

If the attribute you select has named constants as valid values, you can open a list of constants by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.
Output
Name Type Description
value void * The value of the specified progress bar control attribute.

If the attribute you select has named constants as valid values, you can open a list of constants by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.

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