Name

cfree — free allocated memory

Synopsis


#include <stdlib.h>

/* In SunOS 4 */
int cfree( void *  ptr);
/* In glibc or FreeBSD libcompat */
void cfree( void *  ptr);
/* In SCO OpenServer */
void cfree( char *  ptr,
  unsigned   num,
  unsigned   size);
/* In Solaris watchmalloc.so.1 */
void cfree( void *  ptr,
  size_t   nelem,
  size_t   elsize);
[Note] Note
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
cfree():
_BSD_SOURCE || _SVID_SOURCE

DESCRIPTION

This function should never be used. Use free(3) instead.

1-arg cfree

In glibc, the function cfree() is a synonym for free(3), "added for compatibility with SunOS".

Other systems have other functions with this name. The declaration is sometimes in <stdlib.h> and sometimes in <malloc.h>

3-arg cfree

Some SCO and Solaris versions have malloc libraries with a 3-argument cfree(), apparently as an analog to calloc(3).

If you need it while porting something, add

#define cfree(p, n, s) free((p))

to your file.

A frequently asked question is "Can I use free(3) to free memory allocated with calloc(3), or do I need cfree()? Answer: use free(3).

An SCO manual writes: "The cfree routine is provided for compliance to the iBCSe2 standard and simply calls free. The num and size arguments to cfree are not used."

RETURN VALUE

The SunOS version of cfree() (which is a synonym for free(3)) returns 1 on success and 0 on failure. In case of error, errno is set to EINVAL: the value of ptr was not a pointer to a block previously allocated by one of the routines in the malloc(3) family.

CONFORMING TO

The 3-argument version of cfree() as used by SCO conforms to the iBCSe2 standard: Intel386 Binary Compatibility Specification, Edition 2.

SEE ALSO

malloc(3)

COLOPHON

This page is part of release 2.79 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.


  Copyright (c) 2003 Andries Brouwer (aebcwi.nl)

This is free documentation; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.

The GNU General Public License's references to "object code"
and "executables" are to be interpreted as the output of any
document formatting or typesetting system, including
intermediate and printed output.

This manual is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public
License along with this manual; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
USA.