Difference between revisions of "API FCD.GetItemValue"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | API | + | <sidebar>API Contents</sidebar> |
Gets a paths item value from the FCD document | Gets a paths item value from the FCD document | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API FCD|FCD]] | ||
| + | :[[API FCD|GetItemValue]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|STRING]] ''PathName'' | |
:The '.' separated path through the FCD to look in | :The '.' separated path through the FCD to look in | ||
| − | + | [[Variable Types|STRING]] ''ItemName'' | |
:The name of the item to read | :The name of the item to read | ||
| − | + | [[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: '''''""''' | ||
| − | + | ||
| − | [[Variable | + | ==Return value== |
| + | [[Variable Types|STRING]] | ||
Returns the paths item value from the FCD document | Returns the paths item value from the FCD document | ||
| − | |||
| − | |||
| − | === | + | ==Detailed description== |
| − | ====Calling in a calculation | + | 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 | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: result = ::FCD.GetItemValue("pathname", "itemname", "deftext") | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<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
