workbench/libs/commodities/disposecxmsg.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/exec.h>
  15
  16     AROS_LH1(VOID, DisposeCxMsg,
  17
  18 /*  SYNOPSIS */
  19
  20         AROS_LHA(CxMsg *, cxm, A0),
  21
  22 /*  LOCATION */
  23
  24         struct Library *, CxBase, 28, Commodities)
  25
  26 /*  FUNCTION
  27
  28     Delete the commodity message 'cxm'. This function can be used to
  29     swallow all InputEvents by disposing every commodity message of type
  30     CXM_IEVENT.
  31
  32     INPUTS
  33
  34     cxm  -  the commodity message to delete (must NOT be NULL)
  35
  36     RESULT
  37
  38     NOTES
  39
  40     This function can only be used within the context of the input handler,
  41     and not from within a commodities' context; that is if you for instance
  42     get a CXM_IEVENT CxMsg from a commodity sender object, you must
  43     ReplyMsg() it instead of Disposing it.
  44
  45     EXAMPLE
  46
  47     BUGS
  48
  49     SEE ALSO
  50
  51
  52
  53     INTERNALS
  54
  55     HISTORY
  56
  57 ******************************************************************************/
  58
  59 {
  60     AROS_LIBFUNC_INIT
  61
  62     Remove((struct Node *)cxm);
  63     FreeCxStructure(cxm, CX_MESSAGE, CxBase);
  64
  65     AROS_LIBFUNC_EXIT
  66 } /* DisposeCxMsg */