Difference between revisions of "API FCD.GetItemValue"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import API auto-gen)
Line 1: Line 1:
wiki page name
+
API contents
 
Gets a paths item value from the FCD document
 
Gets a paths item value from the FCD document
  

Revision as of 15:34, 10 May 2013

API contents Gets a paths item value from the FCD document


Parameters

STRING PathName

The '.' separated path through the FCD to look in

STRING ItemName

The name of the item to read

STRING DefText

A default value to return if the item is not found
The default value for this parameter is: ""

Return value

STRING

Returns the paths item value from the FCD document

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon: result = ::FCD.GetItemValue("pathname", "itemname", "deftext")