original/man3/wcpcpy.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 .\"
  15 .TH WCPCPY 3  2013-12-10 "GNU" "Linux Programmer's Manual"
  16 .SH NAME
  17 wcpcpy \- copy a wide-character string, returning a pointer to its end
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .sp
  22 .BI "wchar_t *wcpcpy(wchar_t *" dest ", const wchar_t *" src );
  23 .fi
  24 .sp
  25 .in -4n
  26 Feature Test Macro Requirements for glibc (see
  27 .BR feature_test_macros (7)):
  28 .in
  29 .sp
  30 .BR wcpcpy ():
  31 .PD 0
  32 .ad l
  33 .RS 4
  34 .TP 4
  35 Since glibc 2.10:
  36 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  37 .TP
  38 Before glibc 2.10:
  39 _GNU_SOURCE
  40 .RE
  41 .ad
  42 .PD
  43 .SH DESCRIPTION
  44 The
  45 .BR wcpcpy ()
  46 function is the wide-character equivalent of the
  47 .BR stpcpy (3)
  48 function.
  49 It copies the wide-character string pointed to by
  50 .IR src ,
  51 including the terminating null wide character (L\(aq\\0\(aq),
  52 to the array pointed to by
  53 .IR dest .
  54 .PP
  55 The strings may not overlap.
  56 .PP
  57 The programmer must ensure that there
  58 is room for at least
  59 .IR wcslen(src)+1
  60 wide characters at
  61 .IR dest .
  62 .SH RETURN VALUE
  63 .BR wcpcpy ()
  64 returns a pointer to the end of the wide-character string
  65 .IR dest ,
  66 that is, a pointer to the terminating null wide character.
  67 .SH ATTRIBUTES
  68 .SS Multithreading (see pthreads(7))
  69 The
  70 .BR wcpcpy ()
  71 function is thread-safe.
  72 .SH CONFORMING TO
  73 POSIX.1-2008.
  74 .SH SEE ALSO
  75 .BR strcpy (3),
  76 .BR wcscpy (3)
  77 .SH COLOPHON
  78 This page is part of release 3.67 of the Linux
  79 .I man-pages
  80 project.
  81 A description of the project,
  82 information about reporting bugs,
  83 and the latest version of this page,
  84 can be found at
  85 \%http://www.kernel.org/doc/man\-pages/.