API Panel.LinkBar.GetStartPos: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetStartPos
Gets the position the bars start 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 start position is specified on creation of the link or in the SetStartPos 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.GetStartPos(linkbar, true)

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the position the bars start point is located at
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''GetStartPos'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Gets the position the bars start point is located at&nbsp;
-:[[API Panel.LinkBar|LinkBar]]
+|-
-::[[API Panel.LinkBar|GetStartPos]]
+|-
-</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 start point is located at
@@ Line 32: / Line 30: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.LinkBar.GetStartPos(linkbar, true)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation