rom/dos/freeargs.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Free arguments structure from ReadArgs()
   6     Lang: english
   7 */
   8 #include <proto/exec.h>
   9 #include <dos/rdargs.h>
  10 #include "dos_intern.h"
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <proto/dos.h>
  16
  17         AROS_NTLH1(void, FreeArgs,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct RDArgs *, args, D1),
  21
  22 /*  LOCATION */
  23         struct DosLibrary *, DOSBase, 143, Dos)
  24
  25 /*  FUNCTION
  26         FreeArgs() will clean up after a call to ReadArgs(). If the
  27         RDArgs structure was allocated by the system in a call to
  28         ReadArgs(), then it will be freed. If however, you allocated
  29         the RDArgs structure with AllocDosObject(), then you will
  30         have to free it yourself with FreeDosObject().
  31
  32     INPUTS
  33         args            - The data used by ReadArgs(). May be NULL,
  34                           in which case, FreeArgs() does nothing.
  35
  36     RESULT
  37         Some memory will have been returned to the system.
  38
  39     NOTES
  40
  41     EXAMPLE
  42
  43     BUGS
  44
  45     SEE ALSO
  46         ReadArgs()
  47
  48     INTERNALS
  49
  50 *****************************************************************************/
  51 {
  52     AROS_LIBFUNC_INIT
  53
  54     if(!args)
  55         return;
  56
  57     /* ReadArgs() failed. Clean everything up. */
  58     if (args->RDA_DAList)
  59     {
  60         FreeVec(((struct DAList *)args->RDA_DAList)->ArgBuf);
  61         FreeVec(((struct DAList *)args->RDA_DAList)->StrBuf);
  62         FreeVec(((struct DAList *)args->RDA_DAList)->MultVec);
  63         FreeVec((struct DAList *)args->RDA_DAList);
  64
  65         args->RDA_DAList = 0;
  66
  67 #if 0
  68         /*
  69             Why do I put this here. Unless the user has been bad and
  70             set RDA_DAList to something other than NULL, then this
  71             RDArgs structure was allocated by ReadArgs(), so we can
  72             free it. Otherwise the RDArgs was allocated by
  73             AllocDosObject(), so we are not allowed to free it.
  74
  75             See the original AmigaOS autodoc if you don't believe me
  76         */
  77
  78         FreeVec(args);
  79 #endif
  80     }
  81
  82     if (args->RDA_Flags & RDAF_ALLOCATED_BY_READARGS)
  83         FreeVec(args);
  84
  85     AROS_LIBFUNC_EXIT
  86
  87 } /* FreeArgs */