lib/libc/stdlib/reallocf.3

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