Difference between revisions of "API FCD.GetItemHandle"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==FCDGetItemHandle==
+
Gets a FCD items handle, suitable for traversal with the Tree API
  
Gets a FCD items handle, suitable for traversal with the Tree API
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 21: Line 19:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====Calling in a calculation====
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
 
* Add to a calculation icon: result = ::FCD.GetItemHandle(pathname, "itemname")
 
* Add to a calculation icon: result = ::FCD.GetItemHandle(pathname, "itemname")

Revision as of 15:34, 10 May 2013

wiki page name Gets a FCD items handle, suitable for traversal with the Tree API


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")