Arw GetColor

Returns an RGB color number or a legacy color value that correspond to the color of the arrow contained in an arrow object with the specified ID number.

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

Usage

Arw_GetColor(ObjectID)

Where:

ObjectID - a numerical expression specifying the object ID number.

Notes

• An object-specific ID number is assigned by Arw_New, Arw_New_s, Arw_New_self or Arw_New_self_s when the arrow object is created.
• Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.
• Use Arw_SetColor to set the color of a specified arrow.

Examples

Assign an RGB color number, corresponding to the color of the arrow contained in an arrow object with the ID number of 3, to Value1 variable:

Value1 = Arw_GetColor(3);

Assign a legacy color value, corresponding to the color of the arrow contained in an arrow object with the ID number of 3, to Value1 variable:

[LegacyColorValue = True];
Value1 = Arw_GetColor(3);