API Component.Property.GetValue: Difference between revisions

Latest revision as of 14:11, 13 July 2026

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

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Gets the value of a property as a string
+| width="90%" class="mtx-class-macrohead" | '''GetValue'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Gets the value of a property as a string&nbsp;
-====Class hierarchy====
+|-
-[[API Component|Component]]
+|-
-:[[API Component.Property|Property]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-::[[API Component.Property|GetValue]]
+| width="90%" | Handle
-</div>
+|-
-__TOC__
+| colspan="2" | The component handle of the property owner&nbsp;
+|-
-==Parameters==
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-[[Variable Types|HANDLE]] ''Handle''
+| width="90%" | Property
-:The component handle of the property owner
+|-
+| colspan="2" | The textual name of the property&nbsp;
-[[Variable Types|STRING]] ''Property''
+|-
-: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''
+|}
-==Return value==
-[[Variable Types|STRING]]
-Returns the value of a property as a string
@@ Line 40: / Line 36: @@
 * Declare a variable 'result' of type STRING
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetValue(handle, "property")</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation