RectangleGetActive

From MultiCharts
Jump to navigation Jump to search

This reserved word returns a numeric value representing the ID of the currently active rectangle.

Usage

RectangleGetActive

Notes

When the reserved word performs its operation successfully, rectangle ID is returned.
When a reserved word cannot perform its operation, it returns an error code.

Example

Value1=RectangleGetActive;

Assigns the ID of the currently active rectangle to Value1.
Value1 is any numeric variable or array.
Rectangle reserved word should be assigned to a numeric variable or array in order to determine whether the reserved word performed its operation successfully or not.