Difference between revisions of "API FCD.GetItemHandle"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''PathName''
+
[[Variable Types|HANDLE]] ''PathName''
 
:An existing handle or the '.' separated path through the FCD to look in
 
:An existing handle or the '.' separated path through the FCD to look in
  
[[Variable types|STRING]] ''ItemName''
+
[[Variable Types|STRING]] ''ItemName''
 
:The name of an item in the path to find
 
:The name of an item in the path to find
  
  
 
==Return value==
 
==Return value==
[[Variable types|HANDLE]]
+
[[Variable Types|HANDLE]]
  
 
Returns the FCD items handle, suitable for traversal with the Tree API
 
Returns the FCD items handle, suitable for traversal with the Tree API

Revision as of 11:08, 10 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 information