eant_ColorAddToList

Go Back

Summary:
  Add an Eant_Color to the list of Colors.

Header File:
  eant_Color.h

Library Name:
  elib

long    eant_ColorAddToList  (
    Eant_Color*    inColor,
    Edlm_List*    colorList,
    Emsc_Boolean    lookForDups,
    Eerr_ErrorReport**    lclerr,
  )
colorList
    The list of colors.
inColor
    The color to add to the list.
lclerr
    Error handling structure pointer.
lookForDups
    The flag indicating whether to look for duplicate entries in the list.

Description:
  Add an Eant_Color to the list of Colors. If there is a free spot in the list, the new style replaces it. If lookForDups is true and the color already exists in the list, the input color is freed and the position of the current color is returned. Otherwise, the input color is appended to the end of the list. The position in the list at which the new color was added is returned.

Notes:
  None.

Return Description:
  Upon success this function returns long. If an error occurs this function calls eerr_CreateErrorReport.