API FCD.GetPathHandle: Difference between revisions
XML import of API auto-gen |
XML import API auto-gen |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
Gets a FCD paths handle, suitable for traversal with the Tree API | |||
===Parameters=== | ===Parameters=== | ||
| Line 22: | Line 20: | ||
===Examples=== | ===Examples=== | ||
====Calling in a calculation | ====Calling in a calculation==== | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: result = ::FCD.GetPathHandle("pathname", startpoint) | * Add to a calculation icon: result = ::FCD.GetPathHandle("pathname", startpoint) | ||
Revision as of 15:34, 10 May 2013
wiki page name Gets a FCD paths handle, suitable for traversal with the Tree API
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
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon: result = ::FCD.GetPathHandle("pathname", startpoint)