Difference between revisions of "API FCD.GetItemHandle"
From Flowcode Help
Jump to navigationJump to search (XML import of API documentation) |
|||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <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 | ||
Revision as of 14:27, 9 August 2013
<sidebar>API Contents</sidebar>
Gets a FCD items handle, suitable for traversal with the Tree API
Contents
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
Returns the FCD items handle, suitable for traversal with the Tree API
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")
No additional examples
