rom/intuition/freeremember.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include "intuition_intern.h"
   8 #include <exec/memory.h>
   9 #include <proto/exec.h>
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <intuition/intuition.h>
  15 #include <proto/intuition.h>
  16
  17     AROS_LH2(void, FreeRemember,
  18
  19 /*  SYNOPSIS */
  20          AROS_LHA(struct Remember **, rememberKey, A0),
  21          AROS_LHA(LONG              , reallyForget, D0),
  22
  23 /*  LOCATION */
  24          struct IntuitionBase *, IntuitionBase, 68, Intuition)
  25
  26 /*  FUNCTION
  27         Free memory allocated by AllocRemember().
  28
  29     INPUTS
  30         rememberKey  - address of a pointer to struct Remember
  31         reallyForget - TRUE  release all memory
  32                        FALSE release only link nodes
  33
  34     RESULT
  35
  36     NOTES
  37
  38     EXAMPLE
  39
  40     BUGS
  41
  42     SEE ALSO
  43         AllocRemember()
  44
  45     INTERNALS
  46
  47     HISTORY
  48     27-11-96    digulla automatically created from
  49                 intuition_lib.fd and clib/intuition_protos.h
  50
  51 *****************************************************************************/
  52 {
  53     AROS_LIBFUNC_INIT
  54
  55     struct Remember *next, *key;
  56
  57     DEBUG_REMEMBER(dprintf("FreeRemember: Key 0x%lx ReallyForget %d\n",
  58                            rememberKey, reallyForget));
  59
  60     for (next = *rememberKey; (key = next); )
  61     {
  62         next = key->NextRemember;
  63
  64         if (reallyForget)
  65             FreeMem (key->Memory, key->RememberSize);
  66
  67         FreeMem (key, sizeof (struct Remember));
  68     }
  69
  70     *rememberKey = NULL;
  71
  72     AROS_LIBFUNC_EXIT
  73 } /* FreeRemember */