Procedure UserColorGetRGB(color\_name, red, green, blue)

UserColorGetRGB

With the procedure UserColorGetRGB you can programmatically obtain the RGB values of a color in the set of user colors.

UserColorGetRGB(
     color_name,          ! (input) scalar string expression
     red,                 ! (output) scalar numerical parameter
     green,               ! (output) scalar numerical parameter
     blue                 ! (output) scalar numerical parameter
     )

Arguments

color_name

A string expression holding the name of the user color to query.

red

An scalar parameter that, on return, holds the red component in the RGB value of the color.

green

An scalar parameter that, on return, holds the green component in the RGB value of the color.

blue

An scalar parameter that, on return, holds the blue component in the RGB value of the color.

Return Value

The procedure returns 1 if the color exists in the set of user colors, or 0 if the color does not exist.

See also

UserColorAdd, UserColorDelete, UserColorModify. User colors are discussed in full detail in Setting colors within the model.