lib/libc/string/strdup.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. 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 .\"     @(#)strdup.3    8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/string/strdup.3,v 1.7.2.2 2001/12/14 18:33:59 ru Exp $
  34 .\" $DragonFly: src/lib/libc/string/strdup.3,v 1.5 2004/12/26 12:37:08 swildner Exp $
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt STRDUP 3
  38 .Os
  39 .Sh NAME
  40 .Nm strdup
  41 .Nd save a copy of a string
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In string.h
  46 .Ft char *
  47 .Fn strdup "const char *str"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn strdup
  51 function
  52 allocates sufficient memory for a copy
  53 of the string
  54 .Fa str ,
  55 does the copy, and returns a pointer to it.
  56 The pointer may subsequently be used as an
  57 argument to the function
  58 .Xr free 3 .
  59 .Pp
  60 If insufficient memory is available, NULL is returned.
  61 .Sh ERRORS
  62 The
  63 .Nm
  64 function may fail if:
  65 .Bl -tag -width Er
  66 .It Bq Er ENOMEM
  67 No memory could be allocated for the copy of the string.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr free 3 ,
  71 .Xr malloc 3
  72 .Sh STANDARDS
  73 The
  74 .Nm
  75 function conforms to
  76 .St -p1003.1-2004 .
  77 .Sh HISTORY
  78 The
  79 .Fn strdup
  80 function first appeared in
  81 .Bx 4.4 .