API FCD.GetItemHandle: Difference between revisions
No edit summary |
No edit summary |
||
| Line 37: | Line 37: | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* 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> | ||
Revision as of 11:55, 16 January 2023
|
GetItemHandle |
| Gets a FCD items handle, suitable for traversal with the Tree API | |
 - 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 | |
| - 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")