RectangleGetBeginDate

From MultiCharts
Jump to navigation Jump to search

Returns a numerical value, indicating the date of the starting point of a rectangle with the specified ID number; returns a value of -2 if the specified rectangle ID number is invalid.

Of the two end points of a rectangle, the point with the earlier date and time is always considered to be the starting point; if the rectangle is vertical, the point with the lower price value is considered to be the starting point.

The date is indicated in the YYYMMdd format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month.

Usage

RectangleGetBeginDate(ID)

Where:

ID - a numerical expression specifying the rectangle ID number.

Notes

A rectangle ID number is returned by RectangleNew when the rectangle is created.

Example

Assign a value, indicating the date of the starting point of a rectangle with the ID number of 3, to Value1 variable:

Value1=RectangleGetBeginDate(3);