original/man3/wcscpy.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 WCSCPY 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 wcscpy \- copy a wide-character string
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wchar.h>
  20 .sp
  21 .BI "wchar_t *wcscpy(wchar_t *" dest ", const wchar_t *" src );
  22 .fi
  23 .SH DESCRIPTION
  24 The
  25 .BR wcscpy ()
  26 function is the wide-character equivalent
  27 of the
  28 .BR strcpy (3)
  29 function.
  30 It copies the wide-character string pointed to by \fIsrc\fP,
  31 including the terminating L\(aq\\0\(aq character, to the array pointed to by
  32 \fIdest\fP.
  33 .PP
  34 The strings may not overlap.
  35 .PP
  36 The programmer must ensure that there is
  37 room for at least \fIwcslen(src)+1\fP
  38 wide characters at \fIdest\fP.
  39 .SH "RETURN VALUE"
  40 .BR wcscpy ()
  41 returns \fIdest\fP.
  42 .SH "CONFORMING TO"
  43 C99.
  44 .SH "SEE ALSO"
  45 .BR strcpy (3),
  46 .BR wcpcpy (3),
  47 .BR wcscat (3),
  48 .BR wcsdup (3),
  49 .BR wmemcpy (3)