workbench/libs/commodities/cxobjerror.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(LONG, CxObjError,
  17
  18 /*  SYNOPSIS */
  19
  20         AROS_LHA(CxObj *, co, A0),
  21
  22 /*  LOCATION */
  23
  24         struct Library *, CxBase, 11, Commodities)
  25
  26 /*  FUNCTION
  27
  28     Obtain the ackumulated error of commodity object 'co'.
  29
  30     INPUTS
  31
  32     co  -  the object the error of which to get
  33
  34     RESULT
  35
  36     The ackumulated error of the object 'co'. See <libraries/commodities.h>
  37     for the possible errors.
  38
  39     NOTES
  40
  41     EXAMPLE
  42
  43     BUGS
  44
  45     SEE ALSO
  46
  47     ClearCxObjError()
  48
  49     INTERNALS
  50
  51     There seems to be some kind of RKRM error here. The RKRM says that
  52     COERR_ISNULL is returned if 'co' is NULL. COERR_ISNULL is furthermore
  53     defined as 1 in <libraries/commodities.h>. However, in the RESULTS part
  54     is says "error - the accumulated error, or 0 if 'co' is NULL". As the
  55     commodities.library I have (39.6 I believe) returns 0, I do the same
  56     below.
  57
  58     HISTORY
  59
  60 ******************************************************************************/
  61
  62 {
  63     AROS_LIBFUNC_INIT
  64
  65     return (co == NULL) ? 0 : co->co_Error;
  66
  67     AROS_LIBFUNC_EXIT
  68 } /* CxObjError */