Difference between revisions of "API FCD.GetItemHandle"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Gets a FCD items handle, suitable for traversal with the Tree API
 
Gets a FCD items handle, suitable for traversal with the Tree API
Line 32: Line 34:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemHandle(pathname, "itemname")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemHandle(pathname, "itemname")</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Gets a FCD items handle, suitable for traversal with the Tree API

Class hierarchy

FCD

GetItemHandle

Parameters

HANDLE PathName

An existing handle or the '.' separated path through the FCD to look in

STRING ItemName

The name of an item in the path to find


Return value

HANDLE

Returns the FCD items handle, suitable for traversal with the Tree API


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::FCD.GetItemHandle(pathname, "itemname")

No additional examples