TL GetActive: Difference between revisions
From MultiCharts
(Created page with "This reserved word returns a numeric value representing the ID of the currently active trendline. ==== Usage ==== <syntaxhighlight>TL_GetActive</syntaxhighlight> ==== No...") |
No edit summary |
||
Line 1: | Line 1: | ||
This reserved word returns a numeric value representing the ID of the currently active trendline. | This reserved word returns a numeric value representing the ID of the currently active trendline. | ||
== Usage == | |||
<syntaxhighlight>TL_GetActive</syntaxhighlight> | <syntaxhighlight>TL_GetActive</syntaxhighlight> | ||
== Notes == | |||
When the reserved word performs its operation successfully, trendline ID is returned. | * When the reserved word performs its operation successfully, trendline ID is returned. | ||
* When a reserved word cannot perform its operation, it returns an error code. | |||
When a reserved word cannot perform its operation, it returns an error code. | * TL_GetActive should be assigned to a [[Variable|numeric variable]] or [[Array|array]] in order to determine if the operation is performed successfully. In other words, if the returning value of TL_GetActive isn't saved, it's not possible to check whether or not the selection of the trendline succeeded. | ||
== Example == | |||
<syntaxhighlight>Value1=TL_GetActive;</syntaxhighlight> | <syntaxhighlight>Value1 = TL_GetActive;</syntaxhighlight> | ||
Assigns the ID of the currently active trendline to Value1. | Assigns the ID of the currently active trendline to the Value1 variable. The variable to which the returning value is assigned can be a numeric variable or numeric array. | ||
[[Category:Trendline Drawing]] | [[Category:Trendline Drawing]] |
Revision as of 17:08, 8 March 2012
This reserved word returns a numeric value representing the ID of the currently active trendline.
Usage
TL_GetActive
Notes
- When the reserved word performs its operation successfully, trendline ID is returned.
- When a reserved word cannot perform its operation, it returns an error code.
- TL_GetActive should be assigned to a numeric variable or array in order to determine if the operation is performed successfully. In other words, if the returning value of TL_GetActive isn't saved, it's not possible to check whether or not the selection of the trendline succeeded.
Example
Value1 = TL_GetActive;
Assigns the ID of the currently active trendline to the Value1 variable. The variable to which the returning value is assigned can be a numeric variable or numeric array.