Difference between revisions of "API FCD.GetItemValue"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import API changes)
Line 23: Line 23:
 
==Return value==
 
==Return value==
 
[[Variable types|STRING]]
 
[[Variable types|STRING]]
 +
 
Returns the paths item value from the FCD document
 
Returns the paths item value from the FCD document
  

Revision as of 13:15, 14 May 2013

<sidebar>API contents</sidebar> Gets a paths item value from the FCD document

Class hierarchy

FCD

GetItemValue

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")

No additional information