Difference between revisions of "API System.DeleteHandle"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Deletes any handle created by the component
 
Deletes any handle created by the component
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API System|System]]
 +
:[[API System|DeleteHandle]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] Handle''
+
[[Variable Types|HANDLE]] ''Handle''
 
:The handle of some component-created object
 
:The handle of some component-created object
  
===Return value===
 
[[Variable types|BOOL]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|BOOL]]
  
===Detailed description===
+
Returns true if the operation is a success, else false
''No additional information''
 
  
===Examples===
+
 
====Calling in a calculation====
+
==Detailed description==
 +
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===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 = ::System.DeleteHandle(handle)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.DeleteHandle(handle)</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:58, 16 January 2014

<sidebar>API Contents</sidebar> Deletes any handle created by the component

Class hierarchy

System

DeleteHandle

Parameters

HANDLE Handle

The handle of some component-created object


Return value

BOOL

Returns true if the operation is a success, else false


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::System.DeleteHandle(handle)

No additional examples