Difference between revisions of "API Component.Delete"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Deletes an existing object, removing it from the panel
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Delete'''
 +
|-
 +
| colspan="2" | Deletes an existing object, removing it from the panel&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The object to delete&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API Component|Component]]
 
:[[API Component|Delete]]
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
[[Variable types|HANDLE]] ''Target''
+
This deletes a component.
:The object to delete
 
  
  
==Return value==
+
Root components and component definitions may not be deleted. All other components may be deleted.
[[Variable types|BOOL]]
 
Returns true if the operation is a success, else false
 
  
  
==Detailed description==
+
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.
''<span style="color:red;">No additional information</span>''
 
  
  
Line 27: Line 31:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Delete(target)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Delete(target)</pre>
 
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:54, 16 January 2023

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)