Difference between revisions of "API FCD.GetPathHandle"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API FCD|FCD]] | + | ====Class hierarchy==== |
| + | [[API FCD|FCD]] | ||
:[[API FCD|GetPathHandle]] | :[[API FCD|GetPathHandle]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable types|STRING]] ''PathName'' | |
:The '.' separated path through the FCD to look in | :The '.' separated path through the FCD to look in | ||
| − | + | [[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 22: | Line 23: | ||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 28: | Line 30: | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetPathHandle("pathname", startpoint)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetPathHandle("pathname", startpoint)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:09, 11 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
