rom/utility/freetagitems.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: FreeTagItems()
   6     Lang: english
   7 */
   8 #include <proto/exec.h>
   9 #include "intern.h"
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <utility/tagitem.h>
  15 #include <proto/utility.h>
  16
  17         AROS_LH1(void, FreeTagItems,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct TagItem *, tagList, A0),
  21
  22 /*  LOCATION */
  23         struct UtilityBase *, UtilityBase, 13, Utility)
  24
  25 /*  FUNCTION
  26         Free a list of TagItems which was allocated by AllocateTagItems().
  27
  28     INPUTS
  29         tagList     - A list of TagItems - must have been allocated by
  30                       AllocateTagItems() or CloneTagItems().
  31
  32     RESULT
  33         The memory containing the tagList is returned to the system.
  34
  35     NOTES
  36         The memory will only be freed if the input is non-NULL.
  37
  38     EXAMPLE
  39         struct TagItem *tagList;
  40
  41         tagList =  AllocateTagItems( 4 );
  42
  43         tagList[0].ti_Tag  = NA_Name;
  44         tagList[0].ti_Data = (IPTR)"A list of tags";
  45         tagList[3].ti_Tag  = TAG_DONE;
  46
  47         \* Do what you want with your TagList here ... *\
  48
  49         FreeTagItems( tagList );
  50
  51     BUGS
  52
  53     SEE ALSO
  54         utility/tagitem.h, AllocateTagItems()
  55
  56     INTERNALS
  57
  58 *****************************************************************************/
  59 {
  60     AROS_LIBFUNC_INIT
  61
  62     FreeVec(tagList);
  63
  64     AROS_LIBFUNC_EXIT
  65 } /* FreeTagItems */