libidn: idn-free.h Source File

00001 /* idn-free.h --- Invoke the `free' function releasing memory
00002  *                allocated by libidn functions.
00003  * Copyright (C) 2004 Simon Josefsson
00004  *
00005  * This file is part of GNU Libidn.
00006  *
00007  * GNU Libidn is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Lesser General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2.1 of the License, or (at your option) any later version.
00011  *
00012  * GNU Libidn is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015  * Lesser General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Lesser General Public
00018  * License along with GNU Libidn; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
00020  *
00021  */
00022 
00023 /* I don't recommend using this interface in general.  Use `free'.
00024  *
00025  * I'm told Microsoft Windows may use one set of `malloc' and `free'
00026  * in a library, and another incompatible set in a statically compiled
00027  * application that link to the library, thus creating problems if the
00028  * application would invoke `free' on a pointer pointing to memory
00029  * allocated by the library.  This motivated adding this function.
00030  *
00031  * The theory of isolating all memory allocations and de-allocations
00032  * within a code package (library) sounds good, to simplify hunting
00033  * down memory allocation related problems, but I'm not sure if it is
00034  * worth enough to motivate recommending this interface over calling
00035  * `free' directly, though.
00036  *
00037  * If you have any thoughts or comments on this, please let me know.
00038  */
00039 
00040 void idn_free (void *ptr);