Difference between revisions of "API FCD.GetItemHandle"
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|GetItemHandle]] | :[[API FCD|GetItemHandle]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[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 | ||
| − | + | [[Variable types|STRING]] ''ItemName'' | |
:The name of an item in the path to find | :The name of an item in the path to find | ||
| Line 21: | Line 22: | ||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 27: | Line 29: | ||
* 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.GetItemHandle(pathname, "itemname")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemHandle(pathname, "itemname")</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:09, 11 May 2013
<sidebar>API contents</sidebar> Gets a FCD items handle, suitable for traversal with the Tree API
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")
No additional information
