Difference between revisions of "TL SetAlert"

From MultiCharts
Jump to navigation Jump to search
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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.  
+
Sets the alert status for a trendline with the specified ID number.
 +
 
 +
TL_SetAlert returns a value of 0 if alert status was successfully modified, and a value of -2 if the specified trendline ID number is invalid.  
 
   
 
   
http://www.buyxanaxonlinepill.com/ xanax - buy xanax no rx
+
== Usage ==
 +
<syntaxhighlight>TL_SetAlert(TL_ID, AlertStatus)</syntaxhighlight>
  
==== Parameters ====  
+
== Parameters ==
[[TL_ID]] - a numerical expression specifying the trendline ID number
+
:'''TL_ID''' - a numerical expression specifying the trendline ID number.
  
[[AlertStatus]] - a numerical expression specifying the alert status for the trendline:  
+
:'''AlertStatus''' - a numerical expression specifying the alert status for the trendline:  
 +
::'''0''' - Alert disabled.
  
0 - Alert disabled
+
::'''1''' - Breakout intra-bar.
 +
:::Alert triggering conditions are evaluated intra-bar.
 +
:::An alert is triggered if the High crosses over the trendline or the Low crosses under the trendline.
  
1 - Breakout intra-bar  
+
::'''2''' - Breakout on close.
 +
:::Alert triggering conditions are evaluated at Close of a bar.
 +
:::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.
  
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.
+
::'''3''' - Once Per Bar.
 +
:::Alert triggering conditions are evaluated intra-bar.
 +
:::An alert is triggered on the first crossover of the trendline within the bar, all subsequent triggers within this bar are ignored.
  
2 - Breakout on close
+
== Notes ==
 
+
* A trendline-specific ID number is returned by [[TL_New]] when the trendline is created.
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.
+
* Use [[TL_GetAlert]] to get the alert properties of an already existing trendline.
 
==== Notes ====  
 
A trendline-specific ID number is returned by [[TL_New]] when the trendline is created.  
 
 
   
 
   
==== Example ====
+
== Example ==
 
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:  
  
<syntaxhighlight>Value1=TL_SetAlert(3,2);</syntaxhighlight>
+
<syntaxhighlight>Value1 = TL_SetAlert(3, 2);</syntaxhighlight>
 
   
 
   
 
[[Category:Trendline Drawing]]
 
[[Category:Trendline Drawing]]

Latest revision as of 13:12, 1 June 2017

Sets the alert status for a trendline with the specified ID number.

TL_SetAlert 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.
Alert triggering conditions are evaluated intra-bar.
An alert is triggered if the High crosses over the trendline or the Low crosses under the trendline.
2 - Breakout on close.
Alert triggering conditions are evaluated at Close of a bar.
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.
3 - Once Per Bar.
Alert triggering conditions are evaluated intra-bar.
An alert is triggered on the first crossover of the trendline within the bar, all subsequent triggers within this bar are ignored.

Notes

  • A trendline-specific ID number is returned by TL_New when the trendline is created.
  • Use TL_GetAlert to get the alert properties of an already existing trendline.

Example

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

Value1 = TL_SetAlert(3, 2);