workbench/libs/commodities/clearcxobjerror.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 /*****************************************************************************
  10
  11     NAME */
  12
  13 #include "cxintern.h"
  14 #include "proto/commodities.h"
  15
  16     AROS_LH1I(VOID, ClearCxObjError,
  17
  18 /*  SYNOPSIS */
  19
  20         AROS_LHA(CxObj *, co, A0),
  21
  22 /*  LOCATION */
  23
  24         struct Library *, CxBase, 12, Commodities)
  25
  26 /*  FUNCTION
  27
  28     Clears the accumulated error of the commodity object 'co'.
  29
  30     INPUTS
  31
  32     co  --  the object in question
  33
  34     RESULT
  35
  36     NOTES
  37
  38     An error of type COERR_BADFILTER should not be cleared as this tells
  39     commodities that the filter in question is all right, and this is not
  40     what you want. Set a correct filter (via SetFilter() or SetFilterIX())
  41     or don't change the error value.
  42
  43     EXAMPLE
  44
  45     BUGS
  46
  47     SEE ALSO
  48
  49     CxObjError()
  50
  51     INTERNALS
  52
  53     HISTORY
  54
  55 ******************************************************************************/
  56
  57 {
  58     AROS_LIBFUNC_INIT
  59
  60     if (co != NULL)
  61     {
  62         co->co_Error = 0;
  63     }
  64
  65     AROS_LIBFUNC_EXIT
  66 } /* ClearCxObject */