Difference between revisions of "API FCD.GetPathHandle"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
Line 16: | Line 16: | ||
:The handle of an existing FCD path to start the search | :The handle of an existing FCD path to start the search | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
+ | |||
==Return value== | ==Return value== | ||
Line 21: | Line 22: | ||
Returns the FCD paths handle, suitable for traversal with the Tree API | Returns the FCD paths handle, suitable for traversal with the Tree API | ||
+ | |||
==Detailed description== | ==Detailed description== |
Revision as of 01:53, 12 May 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
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)
No additional information