guiCheckBoxIsChecked (Function)

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

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;