Difference between revisions of "API FCD.GetPathHandle"
(XML import of updated API docs) |
|||
| Line 27: | Line 27: | ||
==Detailed description== | ==Detailed description== | ||
| − | '' | + | 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. |
| + | |||
| + | |||
| + | 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". | ||
| + | |||
Revision as of 10:01, 4 August 2013
<sidebar>API contents</sidebar>
Gets a FCD paths handle, suitable for traversal with the Tree API
Contents
Parameters
STRING PathName
- The '.' separated path through the FCD to look in
HANDLE StartPoint
- The handle of an existing FCD path to start the search
- The default value for this parameter is: 0
Return value
Returns the FCD paths 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 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)
No additional examples
