xref: /freebsd/lib/libc/stdlib/reallocf.3 (revision 96950419f15510287080c557174e0d8409f06956)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd January 31, 2010
33.Dt MALLOC 3
34.Os
35.Sh NAME
36.Nm reallocf
37.Nd memory reallocation function
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In stdlib.h
42.Ft void *
43.Fn reallocf "void *ptr" "size_t size"
44.Sh DESCRIPTION
45The
46.Fn reallocf
47function is identical to the
48.Fn realloc
49function, except that it
50will free the passed pointer when the requested memory cannot be allocated.
51This is a
52.Fx
53specific API designed to ease the problems with traditional coding styles
54for
55.Fn realloc
56causing memory leaks in libraries.
57.Sh RETURN VALUES
58The
59.Fn reallocf
60function returns a pointer, possibly identical to
61.Fa ptr ,
62to the allocated memory
63if successful; otherwise a
64.Dv NULL
65pointer is returned, and
66.Va errno
67is set to
68.Er ENOMEM
69if the error was the result of an allocation failure.
70The
71.Fn reallocf
72function deletes the original buffer when an error occurs.
73.Sh SEE ALSO
74.Xr realloc 3
75.Sh HISTORY
76The
77.Fn reallocf
78function first appeared in
79.Fx 3.0 .
80