API Component.Delete

From Flowcode Help
Jump to navigationJump to search
Fc9-comp-macro.png Delete
Deletes an existing object, removing it from the panel 
Fc9-h32-icon.png - HANDLE Target
The object to delete 
Fc9-bool-icon.png - BOOL Return


Detailed description

This deletes a component.


Root components and component definitions may not be deleted. All other components may be deleted.


The components memory may not be freed immediately. The system will queue deleted components and erase the memory when the component is not referenced. Therefore a component may delete itself in its own event macro and safely complete processing.


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Component.Delete(target)