Difference between revisions of "API Component.Delete"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
(XML import)
 
Line 1: Line 1:
 
 
 
<sidebar>API Contents</sidebar>
 
<sidebar>API Contents</sidebar>
 
Deletes an existing object, removing it from the panel
 
Deletes an existing object, removing it from the panel

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Deletes an existing object, removing it from the panel

Class hierarchy

Component

Delete

Parameters

HANDLE Target

The object to delete


Return value

BOOL

Returns true if the operation is a success, else false


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)

No additional examples