wcscpy - Man Page
copy a wide-character string, returning a pointer to its end
Prolog
This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.
Synopsis
#include <wchar.h> wchar_t *wcpcpy(wchar_t *restrict ws1, const wchar_t *restrict ws2); wchar_t *wcscpy(wchar_t *restrict ws1, const wchar_t *restrict ws2);
Description
For wcscpy(): The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2017 defers to the ISO C standard.
The wcpcpy() and wcscpy() functions shall copy the wide-character string pointed to by ws2 (including the terminating null wide-character code) into the array pointed to by ws1.
The application shall ensure that there is room for at least wcslen(ws2)+1 wide characters in the ws1 array, and that the ws2 and ws1 arrays do not overlap.
If copying takes place between objects that overlap, the behavior is undefined.
Return Value
The wcpcpy() function shall return a pointer to the terminating null wide-character code copied into the ws1 buffer.
The wcscpy() function shall return ws1.
No return values are reserved to indicate an error.
Errors
No errors are defined.
The following sections are informative.
Examples
None.
Application Usage
None.
Rationale
None.
Future Directions
None.
See Also
The Base Definitions volume of POSIX.1-2017, <wchar.h>
Copyright
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .
Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .
Referenced By
strcpy(3p), wchar.h(0p), wcsdup(3p), wcsncpy(3p).