manual/LDP_man-pages/original/man3/stpncpy.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"
  11 .\" Corrected, aeb, 990824
  12 .TH STPNCPY 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  13 .SH NAME
  14 stpncpy \- copy a fixed-size string, returning a pointer to its end
  15 .SH SYNOPSIS
  16 .nf
  17 .B #define _GNU_SOURCE
  18 .br
  19 .B #include <string.h>
  20 .sp
  21 .BI "char *stpncpy(char *" dest ", const char *" src ", size_t " n );
  22 .fi
  23 .SH DESCRIPTION
  24 The
  25 .BR stpncpy ()
  26 function copies at most \fIn\fP characters from the string
  27 pointed to by \fIsrc\fP, including the terminating \(aq\\0\(aq character,
  28 to the array pointed to by \fIdest\fP.
  29 Exactly \fIn\fP characters are written at
  30 \fIdest\fP.
  31 If the length \fIstrlen(src)\fP is smaller than \fIn\fP, the
  32 remaining characters in the array pointed to by \fIdest\fP are filled
  33 with \(aq\\0\(aq characters.
  34 If the length \fIstrlen(src)\fP is greater or equal to
  35 \fIn\fP, the string pointed to by \fIdest\fP will
  36 not be \(aq\\0\(aq terminated.
  37 .PP
  38 The strings may not overlap.
  39 .PP
  40 The programmer must ensure that there is room for at least \fIn\fP characters
  41 at \fIdest\fP.
  42 .SH "RETURN VALUE"
  43 .BR stpncpy ()
  44 returns a pointer to the terminating null
  45 in \fIdest\fP, or, if \fIdest\fP is not null-terminated,
  46 \fIdest + n\fP.
  47 .SH "CONFORMING TO"
  48 This function is a GNU extension.
  49 .SH "SEE ALSO"
  50 .BR strncpy (3),
  51 .BR wcpncpy (3),
  52 .BR feature_test_macros (7)