API Component.Delete: Difference between revisions
XML import API changes |
No edit summary |
||
| Line 21: | Line 21: | ||
==Detailed description== | ==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. | |||
Revision as of 11:05, 7 June 2013
<sidebar>API contents</sidebar> Deletes an existing object, removing it from the panel
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.
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Component.Delete(target)
No additional information