xref: /freebsd/lib/libc/stdlib/reallocf.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.\"     @(#)malloc.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd January 31, 2010
35.Dt MALLOC 3
36.Os
37.Sh NAME
38.Nm reallocf
39.Nd memory reallocation function
40.Sh LIBRARY
41.Lb libc
42.Sh SYNOPSIS
43.In stdlib.h
44.Ft void *
45.Fn reallocf "void *ptr" "size_t size"
46.Sh DESCRIPTION
47The
48.Fn reallocf
49function is identical to the
50.Fn realloc
51function, except that it
52will free the passed pointer when the requested memory cannot be allocated.
53This is a
54.Fx
55specific API designed to ease the problems with traditional coding styles
56for
57.Fn realloc
58causing memory leaks in libraries.
59.Sh RETURN VALUES
60The
61.Fn reallocf
62function returns a pointer, possibly identical to
63.Fa ptr ,
64to the allocated memory
65if successful; otherwise a
66.Dv NULL
67pointer is returned, and
68.Va errno
69is set to
70.Er ENOMEM
71if the error was the result of an allocation failure.
72The
73.Fn reallocf
74function deletes the original buffer when an error occurs.
75.Sh SEE ALSO
76.Xr realloc 3
77.Sh HISTORY
78The
79.Fn reallocf
80function first appeared in
81.Fx 3.0 .
82