GetHSB Method (Color)

PLBCMP GUI Only, 9.6

The GetHSB method returns the current color as a HSB (Hue, Saturation, Brightness) value. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A COLOR object that has been created.

return

Required. A Numeric Variable that returns the HSB value.

Flags Affected: OVER, ZERO

Note the following:

1. If the value returned is zero, the ZERO Condition Flag is set.

2. If the {return} variable is too small to contain the HSB value, the OVER condition flag is set.

See Also: COLOR, COLOR Methods, Method Syntax