TL GetAlert

From MultiCharts
Jump to: navigation, search

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

TL_GetAlert returns a value of -2 if the specified trendline ID number is invalid.

Usage

TL_GetAlert(TL_ID)

Where:

TL_ID - a numerical expression specifying the trendline ID number.

Return values

Alert status:

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_SetAlert to set an alert for a specified trendline.

Example

Assign a value, indicating the alert status for a trendline with the ID number of 3, to the Value1 variable:

Value1 = TL_GetAlert(3);