Difference between revisions of "API FCD.GetItemHandle"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Gets a FCD items handle, suitable for traversal with the Tree API | Gets a FCD items handle, suitable for traversal with the Tree API | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :FCD | ||
| + | ::GetItemHandle | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] PathName'' | ''[[Variable types|HANDLE]] PathName'' | ||
:An existing handle or the '.' separated path through the FCD to look in | :An existing handle or the '.' separated path through the FCD to look in | ||
| Line 10: | Line 16: | ||
:The name of an item in the path to find | :The name of an item in the path to find | ||
| − | + | ==Return value== | |
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
Returns the FCD items handle, suitable for traversal with the Tree API | Returns the FCD items 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.GetItemHandle(pathname, "itemname")</pre> |
Revision as of 16:45, 11 May 2013
<sidebar>API contents</sidebar> Gets a FCD items handle, suitable for traversal with the Tree API
Class hierarchy
- FCD
- GetItemHandle
Contents
Parameters
HANDLE PathName
- An existing handle or the '.' separated path through the FCD to look in
STRING ItemName
- The name of an item in the path to find
Return value
Returns the FCD items 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.GetItemHandle(pathname, "itemname")
