original/man3/strdup.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified Sun Jul 25 10:41:34 1993 by Rik Faith (faith@cs.unc.edu)
  28 .\" Modified Wed Oct 17 01:12:26 2001 by John Levon <moz@compsoc.man.ac.uk>
  29 .TH STRDUP 3  2007-07-26 "GNU" "Linux Programmer's Manual"
  30 .SH NAME
  31 strdup, strndup, strdupa, strndupa \- duplicate a string
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <string.h>
  35 .sp
  36 .BI "char *strdup(const char *" s );
  37 .sp
  38 .BI "char *strndup(const char *" s ", size_t " n );
  39 .br
  40 .BI "char *strdupa(const char *" s );
  41 .br
  42 .BI "char *strndupa(const char *" s ", size_t " n );
  43 .fi
  44 .sp
  45 .in -4n
  46 Feature Test Macro Requirements for glibc (see
  47 .BR feature_test_macros (7)):
  48 .in
  49 .sp
  50 .BR strdup ():
  51 _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500
  52 .br
  53 .BR strndup (),
  54 .BR strdupa (),
  55 .BR strndupa ():
  56 _GNU_SOURCE
  57 .SH DESCRIPTION
  58 The
  59 .BR strdup ()
  60 function returns a pointer to a new string which
  61 is a duplicate of the string \fIs\fP.
  62 Memory for the new string is
  63 obtained with
  64 .BR malloc (3),
  65 and can be freed with
  66 .BR free (3).
  67
  68 The
  69 .BR strndup ()
  70 function is similar, but only copies at most
  71 \fIn\fP characters.
  72 If \fIs\fP is longer than \fIn\fP, only \fIn\fP
  73 characters are copied, and a terminating null byte (\(aq\\0\(aq) is added.
  74
  75 .BR strdupa ()
  76 and
  77 .BR strndupa ()
  78 are similar, but use
  79 .BR alloca (3)
  80 to allocate the buffer.
  81 They are only available when using the GNU
  82 GCC suite, and suffer from the same limitations described in
  83 .BR alloca (3).
  84 .SH "RETURN VALUE"
  85 The
  86 .BR strdup ()
  87 function returns a pointer to the duplicated
  88 string, or NULL if insufficient memory was available.
  89 .SH ERRORS
  90 .TP
  91 .B ENOMEM
  92 Insufficient memory available to allocate duplicate string.
  93 .SH "CONFORMING TO"
  94 .\" 4.3BSD-Reno, not (first) 4.3BSD.
  95 .BR strdup ()
  96 conforms to SVr4, 4.3BSD, POSIX.1-2001.
  97 .BR strndup (),
  98 .BR strdupa (),
  99 and
 100 .BR strndupa ()
 101 are GNU extensions.
 102 .SH "SEE ALSO"
 103 .BR alloca (3),
 104 .BR calloc (3),
 105 .BR free (3),
 106 .BR malloc (3),
 107 .BR realloc (3),
 108 .BR wcsdup (3)