+1 888 340 6572

TL GetActive: Difference between revisions

From MultiCharts
No edit summary
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.  
 
TL_GetActive returns -1 if no trendlines are currently selected or were added to a chart yet.
If an active trendline is removed from a chart then TL_GetActive returns -1.
If an inactive trendline is removed from a chart then TL_GetActive returns the object ID number of the currently active trendline.
 
== Usage ==
== Usage ==
<syntaxhighlight>TL_GetActive</syntaxhighlight>  
<syntaxhighlight>TL_GetActive</syntaxhighlight>  
   
   
== Notes ==
== 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 [[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.
* 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.