libini/iniClose.c

   1 /**********************************************************************************
   2  * .
   3  *
   4  *
   5  **************************************************
   6  * This code was created by Peter Harvey @ CodeByDesign.
   7  * Released under LGPL 28.JAN.99
   8  *
   9  * Contributions from...
  10  * -----------------------------------------------
  11  * Peter Harvey         - pharvey@codebydesign.com
  12  **************************************************/
  13
  14 #include "inifile_intern.h"
  15 #include "ini.h"
  16 #include <aros/libcall.h>
  17
  18 /*****************************************************************************
  19
  20     NAME */
  21         AROS_LH1(int, iniClose,
  22
  23 /*  SYNOPSIS */
  24         AROS_LHA(HINI, hIni, D0),
  25
  26 /*  LOCATION */
  27         struct Library *, inifileBase, 10, inifile)
  28
  29 /*  FUNCTION
  30
  31     INPUTS
  32
  33     RESULT
  34
  35     NOTES
  36
  37         iniClose
  38
  39         1. free memory previously allocated for HINI
  40         2. DO NOT save any changes (see iniCommit)
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47
  48     INTERNALS
  49
  50     HISTORY
  51
  52 *****************************************************************************/
  53 {
  54     AROS_LIBFUNC_INIT
  55
  56     /* SANITY CHECKS */
  57     if ( hIni == NULL )
  58         return INI_ERROR;
  59
  60         hIni->hCurObject = hIni->hFirstObject;
  61         while ( iniObjectDelete( hIni ) == INI_SUCCESS )
  62         {
  63         }
  64
  65         free( hIni );
  66
  67         return INI_SUCCESS;
  68
  69     AROS_LIBFUNC_EXIT
  70 } /* iniClose */
  71
  72
  73