Jump to content

API Expand.Property: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen
Admin (talk | contribs)
XML import of API auto-gen
Line 28: Line 28:
====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: result = ::Expand.Property("source", owner, false, true)
* Add to a calculation icon: <pre class="brush:[C]">result = ::Expand.Property("source", owner, false, true)</pre>

Revision as of 15:35, 10 May 2013

<sidebar>API contents</sidebar> Expands a string to the name of a property used in the generated code


Parameters

STRING Source

The property name to expand

HANDLE Owner

A component that owns the property
The default value for this parameter is: this

BOOL AddName

Set true to return the name part of the expansion

BOOL AddValue

Set true to return the value part of the expansion

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 = ::Expand.Property("source", owner, false, true)