API FCD.GetPathHandle

From Flowcode Help
Revision as of 21:17, 11 May 2013 by Admin (talk | contribs) (XML import)
Jump to navigationJump to search

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

===Class hierarchy===API

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)