Arw GetFirst

From MultiCharts
Jump to: navigation, search

Returns a numerical value, indicating the object ID number of the oldest (the first to be added to the current chart) arrow object of the specified origin.

Arw_GetFirst returns a value of -2 if the specified object ID number is invalid.

Usage

Arw_GetFirst(Origin)

Parameters

Origin - a numerical expression specifying the origin of the arrow object, where:
1 - added by the current study,
2 - added by a study other then the current study, or drawn manually by the user,
3 - added by any study, or drawn manually by the user,
4 - added by the current study, or drawn manually by the user,
5 - added by a study other then the current study,
6 - added by any study,
7 - added manually by the user.

Notes

  • If the oldest (the first added) arrow object is deleted, the next oldest (the second added) arrow object becomes the oldest (the first added) arrow object.
  • Use Arw_GetActive or Arw_GetNext as another way to get the object-specific ID number of an already created arrow.

Example

Assign a value, indicating the object ID number of the oldest arrow object added to the chart by the current study, to Value1 variable:

Value1 = Arw_GetFirst(1);