API FCD.GetItemHandle: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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")

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets a FCD items handle, suitable for traversal with the Tree API
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetItemHandle'''
+|-
+| colspan="2" | Gets a FCD items handle, suitable for traversal with the Tree API&nbsp;
+|-
+|-
+| 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&nbsp;
+|-
+| 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&nbsp;
+|-
+| 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''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API FCD|FCD]]
-:[[API FCD|GetItemHandle]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] PathName''
+This will get a handle suitable for traversal by the [[API Tree|Tree]] API which is a collection of functions suitable for traversing the FCD files.
-:An existing handle or the '.' separated path through the FCD to look in
+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".
-''[[Variable types|STRING]] ItemName''
-:The name of an item in the path to find
-==Return value==
+If the ''ItemName'' is not found in the specified location then a 0 handle is returned.
-[[Variable types|HANDLE]]
-Returns the FCD items handle, suitable for traversal with the Tree API
-==Detailed description==
-''No additional information''
 ==Examples==

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation