CBL_SCR_ALLOCATE_COLOR

Syntax:

call "CBL_SCR_ALLOCATE_COLOR" using     table-count
                                        RGB-values
                                        color-attribute
                                        non-exact-match
                              returning status-code

Parameters

table-count

Call prototype (see Key): cblt-x2-compx

Picture: pic x(2) comp-x.

RGB-values

Group predefined as cblt-generic-attr-rgb-values containing:

01 cblt-generic-attr-rgb-values  typedef.
  03 cblte-garv-red-value        cblt-x2-compx.	         *> pic x(2) comp-x.
  03 cblte-garv-green-value      cblt-x2-compx. 	        *> pic x(2) comp-x.
  03 cblte-garv-blue-value       cblt-x2-compx.          *> pic x(2) comp-x.
  03 cblte-garv-filler           cblt-x1-compx occurs 2. *> pic x(2).

color-attribute

Call prototype: cblt-x4-compx occurs ntimes

Picture: pic x4 occurs ntimes.

non-exact-match

Call prototype: cblt-x4-compx occurs ntimes

Picture: pic x occurs ntimes.

status-code

See Library Routines - Key.

On Entry:

`table-count`	The number of colors requested.
	The table of color(s) to search for or add to the colormap.

On Exit:

`color-attribute`	The table of indexes to the colormap corresponding to the colors requested. This can be an existing colormap entry, or an unallocated read-write colormap entry set to the requested color.
`non-exact-match`	The table of flags indicating whether or not the corresponding occurrence of `color-attribute` represents an exact match. Zero if the match was exact, otherwise nonzero.
`table-count`	The number of colors successfully allocated. This is normally the number requested but is less if the call was not entirely successful.
`RGB-values`	The table of RGB values actually used during the search, truncated to suit the environment.
`cblte-garv-filler`	Unused.

Comments:

The RGB value can either be specified as a literal or be obtained using a call to the CBL_SCR_NAME_TO_RGB routine. The algorithm for determining the nearest match is environment-defined.