API FCD.GetPathHandle: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetPathHandle
Gets a FCD paths handle, suitable for traversal with the Tree API
- STRING	PathName
The '.' separated path through the FCD to look in
- HANDLE	StartPoint
The handle of an existing FCD path to start the search
- 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 attributes are located. So to extract a handle to the FLASH memory detailes Pathname="device.memory".

If the StartPoint is provided then it is assumed this is a handle to a previous call to GetPathHandle, and this path is prepended to PathName. So if StartPoint is a handle to "device.configuration" and PathName="settings.setting" then the full path found will be "device.configuration.settings.setting".

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE

Add to a calculation icon:

result = ::FCD.GetPathHandle("pathname", startpoint)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets a FCD paths 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" | '''GetPathHandle'''
+|-
+| colspan="2" | Gets a FCD paths handle, suitable for traversal with the Tree API&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | PathName
+|-
+| colspan="2" | The '.' separated path through the FCD to look in&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | StartPoint
+|-
+| colspan="2" | The handle of an existing FCD path to start the search&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|GetPathHandle]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable types|STRING]] ''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.
-:The '.' separated path through the FCD to look in
-[[Variable types|HANDLE]] ''StartPoint''
+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 attributes are located. So to extract a handle to the FLASH memory detailes ''Pathname''="device.memory".
-:The handle of an existing FCD path to start the search
-:''The default value for this parameter is: '''''0'''
-==Return value==
-[[Variable types|HANDLE]]
-Returns the FCD paths handle, suitable for traversal with the Tree API
+If the ''StartPoint'' is provided then it is assumed this is a handle to a previous call to GetPathHandle, and this path is prepended to ''PathName''. So if ''StartPoint'' is a handle to "device.configuration" and ''PathName''="settings.setting" then the full path found will be "device.configuration.settings.setting".
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 30: / Line 37: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetPathHandle("pathname", startpoint)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation