Jump to content

API FCD.GetItemValue: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
Admin (talk | contribs)
XML import
Line 3: Line 3:


<div style="width:25%; float:right" class="toc">
<div style="width:25%; float:right" class="toc">
===Class hierarchy===
===Class hierarchy===[[API |API ]]
:FCD
:[[API FCD|FCD]]
::GetItemValue
::GetItemValue
</div>
</div>

Revision as of 21:17, 11 May 2013

<sidebar>API contents</sidebar> Gets a paths item value from the FCD document

===Class hierarchy===API

FCD
GetItemValue

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

STRING

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")