rom/exec/freepooled.c

   1 /*
   2     Copyright © 1995-2010, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Free memory allocated by AllocPooled().
   6     Lang: english
   7 */
   8
   9 #include "exec_intern.h"
  10 #include <aros/libcall.h>
  11 #include "memory.h"
  12 #include <exec/memory.h>
  13 #include <proto/exec.h>
  14
  15
  16 /*****************************************************************************
  17
  18     NAME */
  19
  20         AROS_LH3(void,FreePooled,
  21
  22 /*  SYNOPSIS */
  23         AROS_LHA(APTR, poolHeader,A0),
  24         AROS_LHA(APTR, memory,    A1),
  25         AROS_LHA(ULONG,memSize,   D0),
  26
  27 /* LOCATION */
  28         struct ExecBase *, SysBase, 119, Exec)
  29
  30 /*  FUNCTION
  31         Free memory allocated out of a private memory pool.
  32
  33     INPUTS
  34         poolHeader - Handle of the memory pool
  35         memory     - Pointer to the memory
  36         memSize    - Size of the memory chunk
  37
  38     RESULT
  39
  40     NOTES
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47         CreatePool(), DeletePool(), AllocPooled()
  48
  49     INTERNALS
  50         In AROS memory allocated from pool remembers where it came from.
  51         Because of this poolHeader is effectively ignored and is present
  52         only for compatibility reasons. However, do not rely on this! For
  53         other operating systems of Amiga(tm) family this is not true!
  54
  55 ******************************************************************************/
  56 {
  57     AROS_LIBFUNC_INIT
  58
  59     InternalFreePooled(memory, memSize, SysBase);
  60
  61     AROS_LIBFUNC_EXIT
  62 } /* FreePooled */