Difference between revisions of "TL SetAlert"
Jump to navigation
Jump to search
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138) |
|||
| Line 1: | Line 1: | ||
| − | Sets the alert status for a trendline with the specified ID number | + | 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 == | |
| − | <syntaxhighlight>TL_SetAlert(TL_ID,AlertStatus)</syntaxhighlight> | + | <syntaxhighlight>TL_SetAlert(TL_ID, AlertStatus)</syntaxhighlight> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | == 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. | ||
| − | 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. | + | ::'''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. | ||
| − | + | == Notes == | |
| − | A trendline-specific ID number is returned by [[TL_New]] when the trendline is created. | + | * 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: | 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]] | ||
Revision as of 17:27, 8 March 2012
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.
Contents
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.
- 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.
- 2 - Breakout on close.
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);
