Difference between revisions of "Arw GetColor"

From MultiCharts
Jump to navigation Jump to search
Line 6: Line 6:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Where: <syntaxhighlight>ObjectID</syntaxhighlight> - a numerical expression specifying the object ID number  
+
Where: [[ObjectID]] - a numerical expression specifying the object ID number
  
 
==== Notes ====
 
==== Notes ====

Revision as of 12:56, 20 January 2012

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; 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 returned by Arw_New when the arrow object is created.

Example

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);