guiCheckBoxSetChecked (Function)

This function sets the state of the check box.

Calling this function does not trigger the check box changed event.

Input:

check_box : SYSHANDLE

A handle to the check box to change the state for.

checked : BOOL

The wanted state of this check box.

Returns: INT

Declaration:

FUNCTION guiCheckBoxSetChecked : INT;
VAR_INPUT
  check_box : SYSHANDLE;
  checked : BOOL;
END_VAR;

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  rc     : INT;
  check : SYSHANDLE;
END_VAR;
 
BEGIN
  ...
  // Set the check box as checked
  rc := guiCheckBoxSetChecked(check_box := check, checked:=TRUE);
  ...
END;
END_PROGRAM;