Difference between revisions of "API FCD.GetPathHandle"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML Import to change Variable types into Variable Types) |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''PathName'' |
:The '.' separated path through the FCD to look in | :The '.' separated path through the FCD to look in | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''StartPoint'' |
: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''' | ||
| Line 19: | Line 19: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] |
Returns the FCD paths handle, suitable for traversal with the Tree API | Returns the FCD paths handle, suitable for traversal with the Tree API | ||
Revision as of 11:08, 10 June 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
