GETPIXELFROMID(5ICD)

NAME
GetPixelFromId - return the pixel coupled to the Id

SYNOPSIS

GetPixelFromId (Id, ppixel)
int Id;
unsigned long *ppixel;
GetPixelFromIds (Ids, n, ppixel)
int Ids[];
int n;
unsigned long *ppixel;

PARAMETERS

Id(s)
    Id's to identify the pixel value by.

n   specifies the number of Ids.

ppixel
    the address of the location where the pixel should be returned in.

DESCRIPTION
These functions return the pixel value obtained by OR'ing together the pixel values of the specified Id's.

DIAGNOSTICS
If a call to these functions is successful 1 is returned. If a call to these functions fails 0 will be returned and cacdcmaperrno will be set to one of the following values:

NOINIT
    the CACD colormap library was not initialized.

BADID
    a specified Id did not exist.

SEE ALSO
InitCacdCmap(5ICD) CoupleIdToColor(5ICD) CoupleIdToRGB(5ICD) GetAffectedIds(5ICD) SetForegroundFromId(5ICD)

NOTE
These functions should only be used when strictly necessary (such as setting a window background when a window is created) and not be used to set the foreground (or background) pixel of a graphics context (use SetForegroundFromId to accomplish this), since they may not be supported in the future when the library is extended with window (or viewport) creation functions.