Difference between revisions of "API Panel.LinkBar.GetEndPos"
From Flowcode Help
Jump to navigationJump to search (XML import of API documentation) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetEndPos''' | |
| − | + | |- | |
| − | + | | colspan="2" | Gets the position the bars end point is located at | |
| − | === | + | |- |
| − | [[ | + | |- |
| − | : | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | :: | + | | width="90%" | LinkBar |
| − | + | |- | |
| − | + | | colspan="2" | The handle to the bar to read | |
| − | + | |- | |
| − | == | + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL |
| − | [[ | + | | width="90%" | Track |
| − | + | |- | |
| − | + | | colspan="2" | True to get a handle to the original position, false to make a copy | |
| − | [[ | + | |- |
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE | |
| − | + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | |
| − | + | |} | |
| − | == | ||
| − | [[ | ||
| − | |||
| − | |||
| Line 34: | 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> | ||
| − | |||
| − | |||
Latest revision as of 11:54, 16 January 2023
|
GetEndPos |
| Gets the position the bars end point is located at | |
 - HANDLE
|
LinkBar |
| The handle to the bar to read | |
 - BOOL
|
Track |
| True to get a handle to the original position, false to make a copy | |
| - 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)
