API FCD.GetItemValue: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|STRING]] ''PathName'' | ||
:The '.' separated path through the FCD to look in | :The '.' separated path through the FCD to look in | ||
[[Variable | [[Variable Types|STRING]] ''ItemName'' | ||
:The name of the item to read | :The name of the item to read | ||
[[Variable | [[Variable Types|STRING]] ''DefText'' | ||
:A default value to return if the item is not found | :A default value to return if the item is not found | ||
:''The default value for this parameter is: '''''""''' | :''The default value for this parameter is: '''''""''' | ||
| Line 22: | Line 22: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|STRING]] | ||
Returns the paths item value from the FCD document | Returns the paths item value from the FCD document | ||
Revision as of 11:08, 10 June 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")
No additional information