LayerAPI.setColor

 

long setColor(long colorRef)

This method sets the current color of the layer to colorRef, where colorRef is an WINDOWS COLORREF value.  A COLORREF value can be defined using the WINDOWS RGB macro, as follows:

COLORREF colorRef = RGB(r, g, b)

where r, g, and b are byte values between 0 and 255.

The effect of this method is not immediate, i.e. the client or user must view explicitly redraw the view for the change to be seen.  This allows color changes to multiple layers without multiple redraws.

The original color of the layer can be restored via resetColor.

This method returns zero upon success, and returns an error code if the layer is neither a CARIS File Layer nor an ESRI Shape Layer (See Overview of Data Layering).