Difference between revisions of "API Panel.LinkBar.GetEndPos"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets the position the bars end point is located at
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetEndPos'''
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
| colspan="2" | Gets the position the bars end point is located at&nbsp;
:[[API Panel.LinkBar|LinkBar]]
+
|-
::[[API Panel.LinkBar|GetEndPos]]
+
|-
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
+
| width="90%" | LinkBar
 
+
|-
==Parameters==
+
| colspan="2" | The handle to the bar to read&nbsp;
[[Variable Types|HANDLE]] ''LinkBar''
+
|-
:The handle to the bar to read
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
+
| width="90%" | Track
[[Variable Types|BOOL]] ''Track''
+
|-
:True to get a handle to the original position, false to make a copy
+
| colspan="2" | True to get a handle to the original position, false to make a copy&nbsp;
 
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
==Return value==
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
[[Variable Types|HANDLE]]
+
|}
 
 
Returns the position the bars end point is located at
 
  
  
Line 32: Line 30:
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.LinkBar.GetEndPos(linkbar, true)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.LinkBar.GetEndPos(linkbar, true)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png GetEndPos
Gets the position the bars end point is located at 
Fc9-h32-icon.png - HANDLE LinkBar
The handle to the bar to read 
Fc9-bool-icon.png - BOOL Track
True to get a handle to the original position, false to make a copy 
Fc9-h32-icon.png - HANDLE Return


Detailed description

The end position is specified on creation of the link or in the SetEndPos call. This will extract the latest version of this, which may not contain the same values as the original if the position is being tracked.


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Panel.LinkBar.GetEndPos(linkbar, true)