216 lines
5.1 KiB
HTML
216 lines
5.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of CFREE</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>CFREE</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
cfree - free allocated memory
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
|
|
<B>#include <<A HREF="file:///usr/include/stdlib.h">stdlib.h</A>></B>
|
|
|
|
/* In SunOS 4 */
|
|
<B>int cfree(void *</B><I>ptr</I><B>);</B>
|
|
|
|
/* In glibc or FreeBSD libcompat */
|
|
<B>void cfree(void *</B><I>ptr</I><B>);</B>
|
|
|
|
/* In SCO OpenServer */
|
|
<B>void cfree(char *</B><I>ptr</I><B>, unsigned </B><I>num</I><B>, unsigned </B><I>size</I><B>);</B>
|
|
|
|
/* In Solaris watchmalloc.so.1 */
|
|
<B>void cfree(void *</B><I>ptr</I><B>, size_t </B><I>nelem</I><B>, size_t </B><I>elsize</I><B>);</B>
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
|
|
|
|
|
|
<P>
|
|
|
|
<B>cfree</B>():
|
|
|
|
<BR> Since glibc 2.19:
|
|
<BR> _DEFAULT_SOURCE
|
|
<BR> Glibc 2.19 and earlier:
|
|
<BR> _BSD_SOURCE || _SVID_SOURCE
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
This function should never be used.
|
|
Use
|
|
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3)
|
|
|
|
instead.
|
|
Starting with version 2.26, it has been removed from glibc.
|
|
<A NAME="lbAE"> </A>
|
|
<H3>1-arg cfree</H3>
|
|
|
|
In glibc, the function
|
|
<B>cfree</B>()
|
|
|
|
is a synonym for
|
|
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3),
|
|
|
|
"added for compatibility with SunOS".
|
|
<P>
|
|
|
|
Other systems have other functions with this name.
|
|
The declaration is sometimes in
|
|
<I><<A HREF="file:///usr/include/stdlib.h">stdlib.h</A>></I>
|
|
|
|
and sometimes in
|
|
<I><<A HREF="file:///usr/include/malloc.h">malloc.h</A>></I>.
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H3>3-arg cfree</H3>
|
|
|
|
Some SCO and Solaris versions have malloc libraries with a 3-argument
|
|
<B>cfree</B>(),
|
|
|
|
apparently as an analog to
|
|
<B><A HREF="/cgi-bin/man/man2html?3+calloc">calloc</A></B>(3).
|
|
|
|
<P>
|
|
|
|
If you need it while porting something, add
|
|
<P>
|
|
|
|
|
|
|
|
#define cfree(p, n, s) free((p))
|
|
|
|
|
|
<P>
|
|
|
|
to your file.
|
|
<P>
|
|
|
|
A frequently asked question is "Can I use
|
|
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3)
|
|
|
|
to free memory allocated with
|
|
<B><A HREF="/cgi-bin/man/man2html?3+calloc">calloc</A></B>(3),
|
|
|
|
or do I need
|
|
<B>cfree</B>()?
|
|
|
|
Answer: use
|
|
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3).
|
|
|
|
<P>
|
|
|
|
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."
|
|
<A NAME="lbAG"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The SunOS version of
|
|
<B>cfree</B>()
|
|
|
|
(which is a synonym for
|
|
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3))
|
|
|
|
returns 1 on success and 0 on failure.
|
|
In case of error,
|
|
<I>errno</I>
|
|
|
|
is set to
|
|
<B>EINVAL</B>:
|
|
|
|
the value of
|
|
<I>ptr</I>
|
|
|
|
was not a pointer to a block previously allocated by
|
|
one of the routines in the
|
|
<B><A HREF="/cgi-bin/man/man2html?3+malloc">malloc</A></B>(3)
|
|
|
|
family.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>VERSIONS</H2>
|
|
|
|
The
|
|
<B>cfree</B>()
|
|
|
|
function was removed
|
|
|
|
from glibc in version 2.26.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>cfree</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Safe /* In glibc */<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
The 3-argument version of
|
|
<B>cfree</B>()
|
|
|
|
as used by SCO conforms to the iBCSe2 standard:
|
|
Intel386 Binary Compatibility Specification, Edition 2.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+malloc">malloc</A></B>(3)
|
|
|
|
<A NAME="lbAL"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DL>
|
|
<DT id="4"><A HREF="#lbAE">1-arg cfree</A><DD>
|
|
<DT id="5"><A HREF="#lbAF">3-arg cfree</A><DD>
|
|
</DL>
|
|
<DT id="6"><A HREF="#lbAG">RETURN VALUE</A><DD>
|
|
<DT id="7"><A HREF="#lbAH">VERSIONS</A><DD>
|
|
<DT id="8"><A HREF="#lbAI">ATTRIBUTES</A><DD>
|
|
<DT id="9"><A HREF="#lbAJ">CONFORMING TO</A><DD>
|
|
<DT id="10"><A HREF="#lbAK">SEE ALSO</A><DD>
|
|
<DT id="11"><A HREF="#lbAL">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:37 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|