Difference between revisions of "API FCD.GetItemValue"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import of API auto-gen) |
||
| Line 25: | Line 25: | ||
====Calling in a calculation==== | ====Calling in a calculation==== | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: result = ::FCD.GetItemValue("pathname", "itemname", "deftext") | + | * Add to a calculation icon: <pre class="brush:[C]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre> |
Revision as of 15:35, 10 May 2013
<sidebar>API contents</sidebar> 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
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")
