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  2013-11-25 "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
  32 .I n
  33 wide characters from the wide-character
  34 string pointed to by
  35 .IR src ,
  36 including the terminating null wide character (L\(aq\\0\(aq),
  37 to the array pointed to by
  38 .IR dest .
  39 Exactly
  40 .I n
  41 wide characters are
  42 written at
  43 .IR dest .
  44 If the length \fIwcslen(src)\fP is smaller than
  45 .IR n ,
  46 the remaining wide characters in the array
  47 pointed to by
  48 .I dest
  49 are filled
  50 with null wide characters.
  51 If the length \fIwcslen(src)\fP is greater than or equal
  52 to
  53 .IR n ,
  54 the string pointed to by
  55 .I dest
  56 will not be terminated by a null wide character.
  57 .PP
  58 The strings may not overlap.
  59 .PP
  60 The programmer must ensure that there is room for at least
  61 .I n
  62 wide
  63 characters at
  64 .IR dest .
  65 .SH RETURN VALUE
  66 .BR wcsncpy ()
  67 returns
  68 .IR dest .
  69 .SH ATTRIBUTES
  70 .SS Multithreading (see pthreads(7))
  71 The
  72 .BR wcsncpy ()
  73 function is thread-safe.
  74 .SH CONFORMING TO
  75 C99.
  76 .SH SEE ALSO
  77 .BR strncpy (3)
  78 .SH COLOPHON
  79 This page is part of release 3.79 of the Linux
  80 .I man-pages
  81 project.
  82 A description of the project,
  83 information about reporting bugs,
  84 and the latest version of this page,
  85 can be found at
  86 \%http://www.kernel.org/doc/man\-pages/.