API FCD.GetPathHandle: Difference between revisions

Revision as of 16:45, 11 May 2013

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

FCD

GetPathHandle

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

Returns the FCD paths handle, suitable for traversal with the Tree API

No additional information

Add to a calculation icon:

result = ::FCD.GetPathHandle("pathname", startpoint)

@@ Line 2: / Line 2: @@
 Gets a FCD paths handle, suitable for traversal with the Tree API
+<div style="width:25%; float:right" class="toc">
+===Class hierarchy===
+:FCD
+::GetPathHandle
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''[[Variable types|STRING]] PathName''
 :The '.' separated path through the FCD to look in
@@ Line 11: / Line 17: @@
 :''The default value for this parameter is: '''''0'''
-===Return value===
+==Return value==
 [[Variable types|HANDLE]]
 Returns the FCD paths handle, suitable for traversal with the Tree API
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type HANDLE
-* Add to a calculation icon: <pre class="brush:[C]">result = ::FCD.GetPathHandle("pathname", startpoint)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetPathHandle("pathname", startpoint)</pre>