API FCD.GetItemValue: Difference between revisions

Latest revision as of 14:11, 13 July 2026

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

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets a paths item value from the FCD document
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetItemValue'''
+|-
+| colspan="2" | Gets a paths item value from the FCD document&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | PathName
+|-
+| colspan="2" | The '.' separated path through the FCD to look in&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | ItemName
+|-
+| colspan="2" | The name of the item to read&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | DefText
+|-
+| colspan="2" | A default value to return if the item is not found&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API FCD|FCD]]
-:[[API FCD|GetItemValue]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable types|STRING]] ''PathName''
+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".
-:The '.' separated path through the FCD to look in
-[[Variable types|STRING]] ''ItemName''
-:The name of the item to read
-[[Variable types|STRING]] ''DefText''
-:A default value to return if the item is not found
-:''The default value for this parameter is: '''''""'''
-==Return value==
+If the ''ItemName'' is not found in the specified location then ''DefText'' will be returned instead.
-[[Variable types|STRING]]
-Returns the paths item value from the FCD document
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 34: / Line 38: @@
 * Declare a variable 'result' of type STRING
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation