API FCD.GetItemValue: Difference between revisions
No edit summary |
No edit summary |
||
| Line 38: | Line 38: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre> | ||
Revision as of 11:55, 16 January 2023
|
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")