Difference between revisions of "TL SetAlert"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Sets the alert status for a trendline with the specified ID number; returns a value of 0 if alert status was successfully modified, and a value of -2 if the specified trendlin...")
 
Line 23: Line 23:
 
   
 
   
 
==== Example ====
 
==== Example ====
<syntaxhighlight>Set alert status to "Breakout on close" for a trendline with the ID number of 3:  
+
Set alert status to "Breakout on close" for a trendline with the ID number of 3:  
  
Value1=TL_SetAlert(3,2);</syntaxhighlight>
+
<syntaxhighlight>Value1=TL_SetAlert(3,2);</syntaxhighlight>
 
   
 
   
 
[[Category:Trendline Drawing]]
 
[[Category:Trendline Drawing]]

Revision as of 13:17, 27 January 2012

Sets the alert status for a trendline with the specified ID number; returns a value of 0 if alert status was successfully modified, and a value of -2 if the specified trendline ID number is invalid.

Usage

TL_SetAlert(TL_ID,AlertStatus)

Parameters

TL_ID - a numerical expression specifying the trendline ID number

AlertStatus - a numerical expression specifying the alert status for the trendline:

0 - Alert disabled

1 - Breakout intra-bar

An alert is triggered if the High crosses over the trendline or the Low crosses under the trendline. Alert triggering conditions are evaluated intra-bar.

2 - Breakout on close

An alert is triggered if the Close of the previous bar was below the trendline and the Close of the current bar is above the trendline, or if the Close of the previous bar was above the trendline and the Close of the current bar is below the trendline. Alert triggering conditions are evaluated at Close of a bar.

Notes

A trendline-specific ID number is returned by TL_New when the trendline is created.

Example

Set alert status to "Breakout on close" for a trendline with the ID number of 3:

Value1=TL_SetAlert(3,2);