workbench/libs/iffparse/setlocalitempurge.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include "iffparse_intern.h"
   7
   8 /*****************************************************************************
   9
  10     NAME */
  11 #include <proto/iffparse.h>
  12
  13         AROS_LH2(void, SetLocalItemPurge,
  14
  15 /*  SYNOPSIS */
  16         AROS_LHA(struct LocalContextItem *, localItem, A0),
  17         AROS_LHA(struct Hook             *, purgeHook, A1),
  18
  19 /*  LOCATION */
  20         struct Library *, IFFParseBase, 33, IFFParse)
  21
  22 /*  FUNCTION
  23         Inserts a custom purge hook for the given local context item.
  24         The purge hook will be freed when the system wants to delete a local
  25         context item.
  26
  27     INPUTS
  28         localItem  -  pointer to a local context item.
  29         purgeHook  -  pointer to a hook sructure initialized with the purge function.
  30
  31     RESULT
  32
  33     NOTES
  34         The purgehook must call FreeLocalItem() on the local context item after
  35         doing its own resource freeing.
  36
  37
  38     EXAMPLE
  39
  40     BUGS
  41
  42     SEE ALSO
  43         AllocLocalItem(), FreeLocalItem()
  44
  45     INTERNALS
  46
  47 *****************************************************************************/
  48 {
  49     AROS_LIBFUNC_INIT
  50
  51     DEBUG_SETLOCALEITEMPURGE(dprintf("SetLocalItemPurge: localItem %p purgeHook %p\n", localItem, purgeHook));
  52
  53     (void) IFFParseBase;
  54
  55     /* Self - explaining */
  56     GetIntLCI(localItem)->lci_PurgeHook = purgeHook;
  57
  58     DEBUG_SETLOCALEITEMPURGE(dprintf("SetLocalItemPurge: done\n"));
  59
  60     AROS_LIBFUNC_EXIT
  61 } /* SetLocalItemPurge */