man3/wcpcpy.3

   1 '\" t
   2 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   3 .\"
   4 .\" SPDX-License-Identifier: GPL-2.0-or-later
   5 .\"
   6 .\" References consulted:
   7 .\"   GNU glibc-2 source code and manual
   8 .\"   Dinkumware C library reference http://www.dinkumware.com/
   9 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  10 .\"
  11 .TH wcpcpy 3 (date) "Linux man-pages (unreleased)"
  12 .SH NAME
  13 wcpcpy \- copy a wide-character string, returning a pointer to its end
  14 .SH LIBRARY
  15 Standard C library
  16 .RI ( libc ", " \-lc )
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wchar.h>
  20 .P
  21 .BI "wchar_t *wcpcpy(wchar_t *restrict " dest \
  22 ", const wchar_t *restrict " src );
  23 .fi
  24 .P
  25 .RS -4
  26 Feature Test Macro Requirements for glibc (see
  27 .BR feature_test_macros (7)):
  28 .RE
  29 .P
  30 .BR wcpcpy ():
  31 .nf
  32     Since glibc 2.10:
  33         _POSIX_C_SOURCE >= 200809L
  34     Before glibc 2.10:
  35         _GNU_SOURCE
  36 .fi
  37 .SH DESCRIPTION
  38 The
  39 .BR wcpcpy ()
  40 function is the wide-character equivalent of the
  41 .BR stpcpy (3)
  42 function.
  43 It copies the wide-character string pointed to by
  44 .IR src ,
  45 including the terminating null wide character (L\[aq]\e0\[aq]),
  46 to the array pointed to by
  47 .IR dest .
  48 .P
  49 The strings may not overlap.
  50 .P
  51 The programmer must ensure that there
  52 is room for at least
  53 .I wcslen(src)+1
  54 wide characters at
  55 .IR dest .
  56 .SH RETURN VALUE
  57 .BR wcpcpy ()
  58 returns a pointer to the end of the wide-character string
  59 .IR dest ,
  60 that is, a pointer to the terminating null wide character.
  61 .SH ATTRIBUTES
  62 For an explanation of the terms used in this section, see
  63 .BR attributes (7).
  64 .TS
  65 allbox;
  66 lbx lb lb
  67 l l l.
  68 Interface       Attribute       Value
  69 T{
  70 .na
  71 .nh
  72 .BR wcpcpy ()
  73 T}      Thread safety   MT-Safe
  74 .TE
  75 .SH STANDARDS
  76 POSIX.1-2008.
  77 .SH SEE ALSO
  78 .BR strcpy (3),
  79 .BR wcscpy (3)