guiCheckBoxIsChecked (Function)

Top  Previous  Next

Architecture:

NX32L

Device support:

NX-400

Firmware version:

1.00.00


This function returns the current state of the check box.

 

Input:

check_box : SYSHANDLE

A handle to the check box to get the state of.

 

Returns: INT

1

- Check box is checked.

0

- Check box is not checked.

-1

- Interface is not open (see guiOpen).

-3

- Invalid handle.

-11

- The GUI API is not supported.

 

Declaration:

FUNCTION guiCheckBoxIsChecked : INT;
VAR_INPUT
  check_box : SYSHANDLE;
END_VAR;

 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  check : SYSHANDLE;
END_VAR;
 
BEGIN
  ...
  // Check if the check box is checked
  IF guiCheckBoxIsChecked(check_box := check) = 1 THEN
    DebugMsg(message := "Checked");
  END_IF;
  ...
END;
END_PROGRAM;