API FCD.GetItemValue - Revision history

Wiki bot at 11:55, 16 January 2023

2023-01-16T11:55:06Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:39Z

JonnyW: XML import

2014-01-16T15:57:47Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:36Z

XML import of API documentation

JonnyW at 09:50, 4 August 2013

2013-08-04T09:50:07Z

JonnyW: XML import of updated API docs

2013-06-17T09:58:17Z

XML import of updated API docs

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:08:58Z

XML Import to change Variable types into Variable Types

JonnyW: XML import API changes

2013-05-14T13:15:00Z

XML import API changes

Admin: XML import

2013-05-12T21:52:55Z

XML import

Admin: XML import

2013-05-12T01:53:55Z

XML import

← Older revision		Revision as of 11:55, 16 January 2023
Line 38:		Line 38:
	* Declare a variable 'result' of type STRING		* Declare a variable 'result' of type STRING
	* Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets a paths item value from the FCD document
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetItemValue'''
-====Class hierarchy====
+|-
-[[API FCD|FCD]]
+| colspan="2" | Gets a paths item value from the FCD document&nbsp;
-:[[API FCD|GetItemValue]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | PathName
-==Parameters==
+|-
-[[Variable Types|STRING]] ''PathName''
+| colspan="2" | The '.' separated path through the FCD to look in&nbsp;
-:The '.' separated path through the FCD to look in
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-[[Variable Types|STRING]] ''ItemName''
+| width="90%" | ItemName
-:The name of the item to read
+|-
+| colspan="2" | The name of the item to read&nbsp;
-[[Variable Types|STRING]] ''DefText''
+|-
-:A default value to return if the item is not found
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-:''The default value for this parameter is: '''''""'''
+| width="90%" | DefText
+|-
+| colspan="2" | A default value to return if the item is not found&nbsp;
-==Return value==
+|-
-[[Variable Types|STRING]]
+| 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''
-Returns the paths item value from the FCD document
+|}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Gets a paths item value from the FCD document		Gets a paths item value from the FCD document

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Gets a paths item value from the FCD document		Gets a paths item value from the FCD document

← Older revision		Revision as of 09:50, 4 August 2013
Line 30:		Line 30:

	==Detailed description==		==Detailed description==
−	''~~<span style~~="~~color:red;~~"~~>No additional information</span>~~''	+	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.

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Gets a paths item value from the FCD document
@@ Line 36: / Line 38: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::FCD.GetItemValue("pathname", "itemname", "deftext")</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''