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 |API ]]
+
===Class hierarchy===[[API FCD|FCD]]
:[[API FCD|FCD]]
+
:[[API FCD|GetPathHandle]]
::GetPathHandle
 
 
</div>
 
</div>
 
__TOC__
 
__TOC__

Revision as of 21:22, 11 May 2013

<sidebar>API contents</sidebar> Gets a FCD paths handle, suitable for traversal with the Tree API

===Class hierarchy===FCD

GetPathHandle

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

HANDLE

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)