Difference between revisions of "API Component.Delete"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
Line 2: Line 2:
 
Deletes an existing object, removing it from the panel
 
Deletes an existing object, removing it from the panel
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Component
 +
::Delete
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] Target''
 
''[[Variable types|HANDLE]] Target''
 
:The object to delete
 
:The object to delete
  
===Return value===
+
==Return value==
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: <pre class="brush:[C]">result = ::Component.Delete(target)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Delete(target)</pre>

Revision as of 16:01, 11 May 2013

<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

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Component.Delete(target)