API Component.Property.GetValue: Difference between revisions
XML import |
XML import |
||
| Line 2: | Line 2: | ||
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=== | |||
:Component | |||
::Property | |||
:::GetValue | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The component handle of the property owner | :The component handle of the property owner | ||
| Line 10: | Line 17: | ||
:The textual name of the property | :The textual name of the property | ||
==Return value== | |||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
Returns the value of a property as a string | Returns the value of a property as a string | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==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:[cpp]">result = ::Component.Property.GetValue(handle, "property")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetValue(handle, "property")</pre> | ||
Revision as of 15:18, 11 May 2013
<sidebar>API contents</sidebar> Gets the value of a property as a string
Class hierarchy
- Component
- Property
- GetValue
- Property
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
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Component.Property.GetValue(handle, "property")