Difference between revisions of "API Component.Delete"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Deletes an existing object, removing it from the panel | Deletes an existing object, removing it from the panel | ||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Target'' |
:The object to delete | :The object to delete | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|BOOL]] |
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
| Line 27: | Line 27: | ||
| − | The components memory may not be freed immediately. The system will queue deleted components and erase the memory when the component is not referenced. | + | 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. |
| Line 35: | Line 35: | ||
* 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 | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Deletes an existing object, removing it from the panel
Contents
Parameters
HANDLE Target
- The object to delete
Return value
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
