Difference between revisions of "API Component.Property.GetValue"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (18 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Gets the value of a property as a string | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the value of a property as a string | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Handle | ||
| + | |- | ||
| + | | colspan="2" | The component handle of the property owner | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Property | ||
| + | |- | ||
| + | | colspan="2" | The textual name of the property | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | == | + | ==Detailed description== |
| − | + | This call gets the value of a property. All properties are stored as strings internally, though this call will allow the value to be returned (and converted) to a variable of any type. | |
| − | |||
| − | |||
| − | |||
| − | + | Note it is the ''expression'' of the property that is returned. For example, if a property called ''connection'' represents port A, reading the value of ''connection'' will return the value of port A, where as this call would return the string ''"$PORTA"'', which is the stored representation of the property. | |
| − | |||
| − | |||
| − | + | In short, referencing the property variable gets the result of the properties expression, while this call gets the expression itself. | |
| − | |||
| − | + | ||
| − | + | ==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 = ::Component.Property.GetValue(handle, "property")</pre> |
Latest revision as of 11:54, 16 January 2023
|
GetValue |
| Gets the value of a property as a string | |
 - HANDLE
|
Handle |
| The component handle of the property owner | |
 - STRING
|
Property |
| The textual name of the property | |
| - STRING
|
Return |
Detailed description
This call gets the value of a property. All properties are stored as strings internally, though this call will allow the value to be returned (and converted) to a variable of any type.
Note it is the expression of the property that is returned. For example, if a property called connection represents port A, reading the value of connection will return the value of port A, where as this call would return the string "$PORTA", which is the stored representation of the property.
In short, referencing the property variable gets the result of the properties expression, while this call gets the expression itself.
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Component.Property.GetValue(handle, "property")
