Difference between revisions of "API FCD.GetItemValue"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
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=== | ||
| + | :FCD | ||
| + | ::GetItemValue | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|STRING]] PathName'' | ''[[Variable types|STRING]] PathName'' | ||
:The '.' separated path through the FCD to look in | :The '.' separated path through the FCD to look in | ||
| Line 14: | Line 20: | ||
:''The default value for this parameter is: '''''""''' | :''The default value for this parameter is: '''''""''' | ||
| − | + | ==Return value== | |
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
Returns the paths item value from the FCD document | Returns the paths item value from the FCD document | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre> |
Revision as of 16:44, 11 May 2013
<sidebar>API contents</sidebar> Gets a paths item value from the FCD document
Class hierarchy
- FCD
- GetItemValue
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
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")
