original/man3/strcat.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 18:11:47 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" 2007-06-15, Marc Boyer <marc.boyer@enseeiht.fr> + mtk
  31 .\"     Improve discussion of strncat().
  32 .TH STRCAT 3  2012-07-19 "GNU" "Linux Programmer's Manual"
  33 .SH NAME
  34 strcat, strncat \- concatenate two strings
  35 .SH SYNOPSIS
  36 .nf
  37 .B #include <string.h>
  38 .sp
  39 .BI "char *strcat(char *" dest ", const char *" src );
  40 .sp
  41 .BI "char *strncat(char *" dest ", const char *" src ", size_t " n );
  42 .fi
  43 .SH DESCRIPTION
  44 The
  45 .BR strcat ()
  46 function appends the
  47 .I src
  48 string to the
  49 .I dest
  50 string,
  51 overwriting the terminating null byte (\(aq\\0\(aq) at the end of
  52 .IR dest ,
  53 and then adds a terminating null byte.
  54 The strings may not overlap, and the
  55 .I dest
  56 string must have
  57 enough space for the result.
  58 If
  59 .I dest
  60 is not large enough, program behavior is unpredictable;
  61 .IR "buffer overruns are a favorite avenue for attacking secure programs" .
  62 .PP
  63 The
  64 .BR strncat ()
  65 function is similar, except that
  66 .IP * 3
  67 it will use at most
  68 .I n
  69 bytes from
  70 .IR src ;
  71 and
  72 .IP *
  73 .I src
  74 does not need to be null-terminated if it contains
  75 .I n
  76 or more bytes.
  77 .PP
  78 As with
  79 .BR strcat (),
  80 the resulting string in
  81 .I dest
  82 is always null-terminated.
  83 .PP
  84 If
  85 .IR src
  86 contains
  87 .I n
  88 or more bytes,
  89 .BR strncat ()
  90 writes
  91 .I n+1
  92 bytes to
  93 .I dest
  94 .RI ( n
  95 from
  96 .I src
  97 plus the terminating null byte).
  98 Therefore, the size of
  99 .I dest
 100 must be at least
 101 .IR "strlen(dest)+n+1" .
 102
 103 A simple implementation of
 104 .BR strncat ()
 105 might be:
 106 .in +4n
 107 .nf
 108
 109 char*
 110 strncat(char *dest, const char *src, size_t n)
 111 {
 112     size_t dest_len = strlen(dest);
 113     size_t i;
 114
 115     for (i = 0 ; i < n && src[i] != \(aq\\0\(aq ; i++)
 116         dest[dest_len + i] = src[i];
 117     dest[dest_len + i] = \(aq\\0\(aq;
 118
 119     return dest;
 120 }
 121 .fi
 122 .in
 123 .SH RETURN VALUE
 124 The
 125 .BR strcat ()
 126 and
 127 .BR strncat ()
 128 functions return a pointer to the resulting string
 129 .IR dest .
 130 .SH CONFORMING TO
 131 SVr4, 4.3BSD, C89, C99.
 132 .SH NOTES
 133 Some systems (the BSDs, Solaris, and others) provide the following function:
 134
 135     size_t strlcat(char *dest, const char *src, size_t size);
 136
 137 This function appends the null-terminated string
 138 .I src
 139 to the string
 140 .IR dest ,
 141 copying at most
 142 .IR "size\-strlen(dest)\-1"
 143 from
 144 .IR src ,
 145 and adds a null terminator to the result,
 146 .I unless
 147 .IR size
 148 is less than
 149 .IR strlen(dest) .
 150 This function fixes the buffer overrun problem of
 151 .BR strcat (),
 152 but the caller must still handle the possibility of data loss if
 153 .I size
 154 is too small.
 155 The function returns the length of the string
 156 .BR strlcat ()
 157 tried to create; if the return value is greater than or equal to
 158 .IR size ,
 159 data loss occurred.
 160 If data loss matters, the caller
 161 .I must
 162 either check the arguments before the call, or test the function return value.
 163 .BR strlcat ()
 164 is not present in glibc and is not standardized by POSIX,
 165 .\" https://lwn.net/Articles/506530/
 166 but is available on Linux via the
 167 .IR libbsd
 168 library.
 169 .SH SEE ALSO
 170 .BR bcopy (3),
 171 .BR memccpy (3),
 172 .BR memcpy (3),
 173 .BR strcpy (3),
 174 .BR string (3),
 175 .BR strncpy (3),
 176 .BR wcscat (3),
 177 .BR wcsncat (3)