API FCD.GetItemHandle

From Flowcode Help
Jump to navigationJump to search
Fc9-comp-macro.png GetItemHandle
Gets a FCD items handle, suitable for traversal with the Tree API 
Fc9-h32-icon.png - HANDLE PathName
An existing handle or the '.' separated path through the FCD to look in 
Fc9-string-icon.png - STRING ItemName
The name of an item in the path to find 
Fc9-h32-icon.png - HANDLE Return


Detailed description

This will get a handle suitable for traversal by the Tree API which is a collection of functions suitable for traversing the FCD files.


FCD files are XML files. The PathName must be a list of items, not including the XML root tag of the tags where the XML attribute ItemName is to be located. So to extract a handle to the FLASH memory size Pathname="device.memory" and ItemName="bytes".


If the ItemName is not found in the specified location then a 0 handle is returned.


Examples

Calling in a calculation

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