UpdateProgressDialog
int UpdateProgressDialog (int progressDialog, int percentComplete, int processSystemEvents);
Purpose
This function should be called periodically to update the amount of progress indicated by the horizontal bar on a progress dialog.
Parameters
| Input | ||
| Name | Type | Description |
| progressDialog | int | Pass the panel handle of the progress dialog to update. This value must be a value returned by the CreateProgressDialog function. |
| percentComplete | int | Pass the completion percentage (0 to 100) to display in the horizontal progress bar. |
| processSystemEvents | int | This parameter specifies whether or not to process system events while updating the dialog. If you already process events while the operation is in progress, or if you want to lock out all user input and callbacks while the operation is progress, pass 0 or select No in the function panel. If you are displaying the progress of an operation that does not allow events to be processed, but you would like events to be processed, pass a nonzero value or select Yes in the function panel. For more information, see the help for the ProcessSystemEvents function in the User Interface Library. |
Return Value
| Name | Type | Description |
| cancelRequested | int | This control returns 1 if the user has requested to abort the operation by pressing the cancel button or the ESC key. 0 is returned if the user has not requested to abort the operation. if an error occurred while updating the dialog, a negative User Interface Library error code is returned. |
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Example
Refer to userint\intgraph.cws for an example of using the UpdateProgressDialog function.