API Panel.LinkBar.GetStartPos - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:57Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:30Z

JonnyW: XML import

2014-01-16T15:57:51Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:33Z

XML import of API documentation

JonnyW at 15:45, 1 July 2013

2013-07-01T15:45:58Z

JonnyW: XML import of LinkBar API

2013-07-01T10:46:12Z

XML import of LinkBar API

New page

<sidebar>API contents</sidebar>
Gets the position the bars start point is located at

<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Panel|Panel]]
:[[API Panel.LinkBar|LinkBar]]
::[[API Panel.LinkBar|GetStartPos]]
</div>
__TOC__

==Parameters==
[[Variable Types|HANDLE]] ''LinkBar''
:The handle to the bar to read

[[Variable Types|BOOL]] ''Track''
:True to get a handle to the original position, false to make a copy

==Return value==
[[Variable Types|HANDLE]]

Returns the position the bars start point is located at

==Detailed description==
''<span style="color:red;">No additional information</span>''

==Examples==
===Calling in a calculation===
* 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>''

← Older revision		Revision as of 11:54, 16 January 2023
Line 30:		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.GetStartPos(linkbar, true)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.LinkBar.GetStartPos(linkbar, true)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets the position the bars start 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;" | '''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]]
+|}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Gets the position the bars start point is located at		Gets the position the bars start point is located at

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Gets the position the bars start point is located at		Gets the position the bars start point is located at

← Older revision		Revision as of 15:45, 1 July 2013
Line 27:		Line 27:

	==Detailed description==		==Detailed description==
−	~~''<span style="color:red;">No additional information</span>''~~	+	The start position is specified on creation of the link or in the [[API Panel.LinkBar.SetStartPos\|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.