Difference between revisions of "API Component.Delete"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen test) |
|||
| (20 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | == | + | |- |
| + | | 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 | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Target | ||
| + | |- | ||
| + | | colspan="2" | The object to delete | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | === | + | ==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 | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: result = ::Component.Delete(target) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Delete(target)</pre> |
Latest revision as of 11:54, 16 January 2023
|
Delete |
| Deletes an existing object, removing it from the panel | |
 - HANDLE
|
Target |
| The object to delete | |
 - 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)
