original/man3/wcsncpy.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH WCSNCPY 3  2011-09-28 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wcsncpy \- copy a fixed-size string of wide characters
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wchar.h>
  22 .sp
  23 .BI "wchar_t *wcsncpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .BR wcsncpy ()
  28 function is the wide-character equivalent of the
  29 .BR strncpy (3)
  30 function.
  31 It copies at most \fIn\fP wide characters from the wide-character
  32 string pointed to by \fIsrc\fP,
  33 including the terminating null wide character (L\(aq\\0\(aq),
  34 to the array pointed to by \fIdest\fP.
  35 Exactly \fIn\fP wide characters are
  36 written at \fIdest\fP.
  37 If the length \fIwcslen(src)\fP is smaller than \fIn\fP,
  38 the remaining wide characters in the array
  39 pointed to by \fIdest\fP are filled
  40 with null wide characters.
  41 If the length \fIwcslen(src)\fP is greater or equal
  42 to \fIn\fP, the string pointed to by \fIdest\fP
  43 will not be terminated by a null wide character.
  44 .PP
  45 The strings may not overlap.
  46 .PP
  47 The programmer must ensure that there is room for at least \fIn\fP wide
  48 characters at \fIdest\fP.
  49 .SH RETURN VALUE
  50 .BR wcsncpy ()
  51 returns \fIdest\fP.
  52 .SH CONFORMING TO
  53 C99.
  54 .SH SEE ALSO
  55 .BR strncpy (3)