API FCD.GetItemValue: Difference between revisions
m Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead"" |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| Line 2: | Line 2: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetItemValue''' | ||
|- | |- | ||
| colspan="2" | Gets a paths item value from the FCD document | | colspan="2" | Gets a paths item value from the FCD document | ||
Latest revision as of 14:11, 13 July 2026
|
GetItemValue |
| Gets a paths item value from the FCD document | |
 - 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 | |
| - STRING
|
Return |
Detailed description
FCD files are XML files. The PathName must be a list of items, not including the XML root tag of the tags where the XML attribute ItemName is to be located. So to extract the FLASH memory size Pathname="device.memory" and ItemName="bytes".
If the ItemName is not found in the specified location then DefText will be returned instead.
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::FCD.GetItemValue("pathname", "itemname", "deftext")