original/man3/wcsncpy.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 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .TH WCSNCPY 3  2011-09-28 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 wcsncpy \- copy a fixed-size string of wide characters
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wchar.h>
  20 .sp
  21 .BI "wchar_t *wcsncpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
  22 .fi
  23 .SH DESCRIPTION
  24 The
  25 .BR wcsncpy ()
  26 function is the wide-character equivalent of the
  27 .BR strncpy (3)
  28 function.
  29 It copies at most \fIn\fP wide characters from the wide-character
  30 string pointed to by \fIsrc\fP,
  31 including the terminating null wide character (L\(aq\\0\(aq),
  32 to the array pointed to by \fIdest\fP.
  33 Exactly \fIn\fP wide characters are
  34 written at \fIdest\fP.
  35 If the length \fIwcslen(src)\fP is smaller than \fIn\fP,
  36 the remaining wide characters in the array
  37 pointed to by \fIdest\fP are filled
  38 with null wide characters.
  39 If the length \fIwcslen(src)\fP is greater or equal
  40 to \fIn\fP, the string pointed to by \fIdest\fP
  41 will not be terminated by a null wide character.
  42 .PP
  43 The strings may not overlap.
  44 .PP
  45 The programmer must ensure that there is room for at least \fIn\fP wide
  46 characters at \fIdest\fP.
  47 .SH "RETURN VALUE"
  48 .BR wcsncpy ()
  49 returns \fIdest\fP.
  50 .SH "CONFORMING TO"
  51 C99.
  52 .SH "SEE ALSO"
  53 .BR strncpy (3)