Difference between revisions of "API FCD.GetItemValue"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
|||
| Line 30: | Line 30: | ||
==Detailed description== | ==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. | ||
Revision as of 09:50, 4 August 2013
<sidebar>API contents</sidebar>
Gets a paths item value from the FCD document
Contents
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
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")
No additional examples
