Difference between revisions of "API FCD.GetItemHandle"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetItemHandle''' | |
| − | === | + | |- |
| − | [[ | + | | colspan="2" | Gets a FCD items handle, suitable for traversal with the Tree API |
| − | : | + | |- |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |
| − | + | | width="90%" | PathName | |
| − | == | + | |- |
| − | [[ | + | | colspan="2" | An existing handle or the '.' separated path through the FCD to look in |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |
| − | [[ | + | | width="90%" | ItemName |
| − | + | |- | |
| − | + | | colspan="2" | The name of an item in the path to find | |
| − | + | |- | |
| − | == | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | [[ | + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' |
| − | + | |} | |
| − | |||
| Line 38: | 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> | ||
| − | |||
| − | |||
Latest 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")
