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  1999-07-25 "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 \fBwcsncpy\fP() function is the wide-character equivalent of the \fBstrncpy\fP()
  25 function. It copies at most \fIn\fP wide characters from the wide-character
  26 string pointed to by \fIsrc\fP, including the terminating L'\\0' character,
  27 to the array pointed to by \fIdest\fP. Exactly \fIn\fP wide characters are
  28 written at \fIdest\fP. If the length \fIwcslen(src)\fP is smaller than \fIn\fP,
  29 the remaining wide characters in the array pointed to by \fIdest\fP are filled
  30 with L'\\0' characters. If the length \fIwcslen(src)\fP is greater or equal
  31 to \fIn\fP, the string pointed to by \fIdest\fP will not be L'\\0' terminated.
  32 .PP
  33 The strings may not overlap.
  34 .PP
  35 The programmer must ensure that there is room for at least \fIn\fP wide
  36 characters at \fIdest\fP.
  37 .SH "RETURN VALUE"
  38 \fBwcsncpy\fP() returns \fIdest\fP.
  39 .SH "CONFORMING TO"
  40 C99.
  41 .SH "SEE ALSO"
  42 .BR strncpy (3)