workbench/libs/commodities/deletecxobj.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_LH1(VOID, DeleteCxObj,
  17
  18 /*  SYNOPSIS */
  19
  20         AROS_LHA(CxObj *, co, A0),
  21
  22 /*  LOCATION */
  23
  24         struct Library *, CxBase, 8, Commodities)
  25
  26 /*  FUNCTION
  27
  28     Delete the commodity object 'co'. By deleting, it's meant that the
  29     memory used for the object is freed and if the object was in the
  30     commodity hierarchy, it's removed.
  31
  32     INPUTS
  33
  34     co  --  the object to be deleted (may be NULL)
  35
  36     RESULT
  37
  38     NOTES
  39
  40     After deleting the commodity object, the handle 'co' is no longer valid.
  41     Deleteing an object that has other objects attached to it is (that
  42     should be deleted too) is easiest accomplished by using the
  43     DeleteCxObjAll() function.
  44
  45     EXAMPLE
  46
  47     BUGS
  48
  49     SEE ALSO
  50
  51     DeleteCxObjAll(),
  52
  53     INTERNALS
  54
  55     HISTORY
  56
  57 ******************************************************************************/
  58
  59 {
  60     AROS_LIBFUNC_INIT
  61
  62     if (co == NULL)
  63     {
  64         return;
  65     }
  66
  67     RemoveCxObj(co);
  68     FreeCxStructure(co, CX_OBJECT, CxBase);
  69
  70     AROS_LIBFUNC_EXIT
  71 } /* DeleteCxObj */
  72