man3/wcpncpy.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 .\"
  13 .TH WCPNCPY 3 2003-11-01 "GNU" "Linux Programmer's Manual"
  14 .SH NAME
  15 wcpncpy \- copy a fixed-size string of wide characters,
  16 returning a pointer to its end
  17 .SH SYNOPSIS
  18 .nf
  19 .B #define _GNU_SOURCE
  20 .br
  21 .B #include <wchar.h>
  22 .sp
  23 .BI "wchar_t *wcpncpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n );
  24 .fi
  25 .SH DESCRIPTION
  26 The \fBwcpncpy\fP() function is the wide-character equivalent
  27 of the \fBstpncpy\fP() function.
  28 It copies at most \fIn\fP wide characters from the wide-character
  29 string pointed to by \fIsrc\fP, including the terminating L'\\0' character,
  30 to the array pointed to by \fIdest\fP.
  31 Exactly \fIn\fP wide characters are
  32 written at \fIdest\fP.
  33 If the length \fIwcslen(src)\fP is smaller than \fIn\fP,
  34 the remaining wide characters in the array pointed to
  35 by \fIdest\fP are filled with L'\\0' characters.
  36 If the length \fIwcslen(src)\fP is greater or equal
  37 to \fIn\fP, the string pointed to by \fIdest\fP will
  38 not be L'\\0' terminated.
  39 .PP
  40 The strings may not overlap.
  41 .PP
  42 The programmer must ensure that there is room for at least \fIn\fP wide
  43 characters at \fIdest\fP.
  44 .SH "RETURN VALUE"
  45 \fBwcpncpy\fP() returns a pointer to the last wide character written, i.e.
  46 \fIdest + n \- 1\fP.
  47 .SH "CONFORMING TO"
  48 This function is a GNU extension.
  49 .SH "SEE ALSO"
  50 .BR stpncpy (3),
  51 .BR wcsncpy (3),
  52 .BR feature_test_macros (7)