dmColorGetError(3dm)                                      dmColorGetError(3dm)


NAME
     dmColorGetError - returns the value of the error flag.

SYNOPSIS
     #include <dmedia/dm_color.h>

     DMstatus dmColorGetError (const DMcolorconverter converter,
                                     int             *error);

PARAMETERS
     DMcolorconverter converter
          The converter upon which the action is to be applied.

     int *error
          The value of the error flag.

RETURNED VALUE
     DM_COLOR_ERROR_NONE               if operation is successful.
     DM_COLOR_ERROR_INVALID_CONVERTER  if the converter is invalid.

DESCRIPTION
     Every dmColor call returns DMstatus.  The exception to this rule is
     dmColorGetErrorString.  dmColorGetError returns (in "error"), the value
     of the error flag, and the error flag is reset to DM_COLOR_ERROR_NONE.
     When an error occurs, the error flag is set to the appropriate error code
     value and no other errors are recorded until dmColorGetError is called.
     If dmColorGetError returns DM_COLOR_ERROR_NONE in "error", there has been
     no detectable error since the last call to dmColorGetError, or since the
     converter was created.  Initially, the error flag is set to
     DM_COLOR_ERROR_NONE.

SEE ALSO
     dmColor(3dm) dmColorCreate(3dm) dmColorGetErrorString(3dm)


                                                                        Page 1