API FCD.GetItemValue: Difference between revisions
XML import of API auto-gen |
XML import API auto-gen |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
Gets a paths item value from the FCD document | |||
===Parameters=== | ===Parameters=== | ||
| Line 25: | Line 23: | ||
===Examples=== | ===Examples=== | ||
====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: result = ::FCD.GetItemValue("pathname", "itemname", "deftext") | ||
Revision as of 15:34, 10 May 2013
wiki page name 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")