guiFormRemove (Function)

Top  Previous  Next

Architecture:

NX32L

Firmware version:

1.00.00


This function releases the provided form and all the controls on it.

 

 

Input:

form : SYSHANDLE

A handle to the form. Will be made invalid once the form is removed.

 

Returns: INT

0

- Success.

-1

- Interface is not open (see guiOpen).

-3

- The form is not valid or the form is visible.

-11

- The GUI API is not supported.

 

Declaration:

FUNCTION guiFormRemove : INT;
VAR_INPUT
   form : ACCESS SYSHANDLE;
END_VAR;

 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
   rc   : INT;
   form : SYSHANDLE;
END_VAR;
 
BEGIN
   ...
   // Create a form with 5x5 tiles
   rc := guiFormCreate(form := formgrid := 5);
   // Make form visible
   rc := guiFormShow(form := form);
   // Close form
   rc := guiFormClose();
   // Remove form
   rc := guiFormRemove(form := form);
   ...
END;
END_PROGRAM;