GETAFFECTEDIDS(5ICD)

NAME
GetAffectedIds - given a set of Id's return a set of Id's affected by an erase operation

SYNOPSIS

GetAffectedIds (Ids, nIds, AffectedIds, pnaffectedIds)
int Ids[];
int nIds;
int AffectedIds[];
int *pnaffectedIds;

PARAMETERS

Ids Id's to be erased.

nIds
    specifies the number of Ids.

AffectedIds
    array in which the affected Ids are to be returned.

pnaffectedIds
    a pointer to an int specifying the size of the AffectedIds array, upon return the int is set to the actual number of affected Ids.

DESCRIPTION
Given a set of Id's (which must be present in the mapping table), a set of Id's is returned that would be affected when an erase operation is performed on Ids. *pnaffectedIds specifies the size of the user supplied AffectedIds array, when the functions returns this value is set to the number of affected Id's.

DIAGNOSTICS
If the call to GetAffectedIds() is successful 1 is returned. If GetAffectedIds() 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.

ARRAYTOSMALL
    the user supplied AffectedIds array is too small to contain all affected Id's.

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

NOTE
The Ids themselves are also returned as affected Id's.