Difference between revisions of "API Component.Property.GetValue"
(XML import API auto-gen) |
(XML import) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets the value of a property as a string | Gets the value of a property as a string | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Component|Component]] | ||
| + | :[[API Component.Property|Property]] | ||
| + | ::[[API Component.Property|GetValue]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component handle of the property owner | :The component handle of the property owner | ||
| − | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
| − | + | ||
| − | [[Variable | + | ==Return value== |
| + | [[Variable Types|STRING]] | ||
Returns the value of a property as a string | Returns the value of a property as a string | ||
| − | |||
| − | |||
| − | ===Examples | + | ==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: result = ::Component.Property.GetValue(handle, "property") | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetValue(handle, "property")</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the value of a property as a string
Contents
Parameters
HANDLE Handle
- The component handle of the property owner
STRING Property
- The textual name of the property
Return value
Returns the value of a property as a string
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")
No additional examples
