Difference between revisions of "API FCD.GetPathHandle"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Gets a FCD paths handle, suitable for traversal with the Tree API | Gets a FCD paths handle, suitable for traversal with the Tree API | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :FCD | ||
| + | ::GetPathHandle | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|STRING]] PathName'' | ''[[Variable types|STRING]] PathName'' | ||
:The '.' separated path through the FCD to look in | :The '.' separated path through the FCD to look in | ||
| Line 11: | Line 17: | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | + | ==Return value== | |
[[Variable types|HANDLE]] | [[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 | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetPathHandle("pathname", startpoint)</pre> |
Revision as of 16:45, 11 May 2013
<sidebar>API contents</sidebar> Gets a FCD paths handle, suitable for traversal with the Tree API
Class hierarchy
- FCD
- GetPathHandle
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)
