original/man3/wcpcpy.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 WCPCPY 3  2011-10-01 "GNU" "Linux Programmer's Manual"
  14 .SH NAME
  15 wcpcpy \- copy a wide-character string, returning a pointer to its end
  16 .SH SYNOPSIS
  17 .nf
  18 .B #include <wchar.h>
  19 .sp
  20 .BI "wchar_t *wcpcpy(wchar_t *" dest ", const wchar_t *" src );
  21 .fi
  22 .sp
  23 .in -4n
  24 Feature Test Macro Requirements for glibc (see
  25 .BR feature_test_macros (7)):
  26 .in
  27 .sp
  28 .BR wcpcpy ():
  29 .PD 0
  30 .ad l
  31 .RS 4
  32 .TP 4
  33 Since glibc 2.10:
  34 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  35 .TP
  36 Before glibc 2.10:
  37 _GNU_SOURCE
  38 .RE
  39 .ad
  40 .PD
  41 .SH DESCRIPTION
  42 The
  43 .BR wcpcpy ()
  44 function is the wide-character equivalent of the
  45 .BR stpcpy (3)
  46 function.
  47 It copies the wide-character string pointed to by \fIsrc\fP,
  48 including the terminating null wide character (L\(aq\\0\(aq),cw
  49 to the array pointed to by
  50 \fIdest\fP.
  51 .PP
  52 The strings may not overlap.
  53 .PP
  54 The programmer must ensure that there
  55 is room for at least \fIwcslen(src)+1\fP
  56 wide characters at \fIdest\fP.
  57 .SH "RETURN VALUE"
  58 .BR wcpcpy ()
  59 returns a pointer to the end of the wide-character string
  60 \fIdest\fP, that is, a pointer to the terminating null wide character.
  61 .SH "CONFORMING TO"
  62 POSIX.1-2008.
  63 .SH "SEE ALSO"
  64 .BR strcpy (3),
  65 .BR wcscpy (3)