guiProgressBarSetValue (Function)

Top  Previous  Next

Architecture:

NX32L

Device support:

NX-400

Firmware version:

1.00.00


This function updates the value of a progress bar.

 

Input:

progress_bar : SYSHANDLE

A handle to the progress bar to change the value for.

 

value : DINT

The new value to set the progress bar to.

 

Returns: INT

0

- Success.

-1

- Interface is not open (see guiOpen).

-3

- Invalid handle or the value is outside the range.

-11

- The GUI API is not supported.

 

Declaration:

FUNCTION guiProgressBarSetValue : INT;
VAR_INPUT
  progress_bar : SYSHANDLE;
  value        : DINT;
END_VAR;

 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  rc     : INT;
  prgbar : SYSHANDLE;
END_VAR;
 
BEGIN
  ...
  // Set the value to 75
  rc := guiProgressBarSetValue(progress_bar := prgbar, value:=75);
  ...
END;
END_PROGRAM;