Difference between revisions of "API Component.Property.CopyValue"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 2: Line 2:
 
Copies a property value from one target to another
 
Copies a property value from one target to another
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Component
 +
::Property
 +
:::CopyValue
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] Source''
 
''[[Variable types|HANDLE]] Source''
 
:The source component to copy from
 
:The source component to copy from
Line 13: Line 20:
 
:The textual name of the property
 
:The textual name of the property
  
===Return value===
+
==Return value==
 
[[Variable types|STRING]]
 
[[Variable types|STRING]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===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:[cpp]">result = ::Component.Property.CopyValue(source, dest, "property")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.CopyValue(source, dest, "property")</pre>

Revision as of 15:19, 11 May 2013

<sidebar>API contents</sidebar> Copies a property value from one target to another

Class hierarchy

Component
Property
CopyValue

Parameters

HANDLE Source

The source component to copy from

HANDLE Dest

The target component to copy to

STRING Property

The textual name of the property

Return value

STRING

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon:
    result = ::Component.Property.CopyValue(source, dest, "property")