The Open Group Base Specifications Issue 8
IEEE Std 1003.1-2024
Copyright © 2001-2024 The IEEE and The Open Group

NAME

wcpcpy, wcscpy — copy a wide-character string, returning a pointer to its end

SYNOPSIS

#include <wchar.h>

[CX] [Option Start] wchar_t *wcpcpy(wchar_t *restrict ws1, const wchar_t *restrict ws2); [Option End]

wchar_t *wcscpy(wchar_t *restrict
ws1, const wchar_t *restrict ws2);

DESCRIPTION

For wcscpy(): [CX] [Option Start]  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-2024 defers to the ISO C standard. [Option End]

The [CX] [Option Start] wcpcpy() [Option End]  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.

[CX] [Option Start] The wcscpy() and wcpcpy() functions shall not change the setting of errno on valid input. [Option End]

RETURN VALUE

[CX] [Option Start] The wcpcpy() function shall return a pointer to the terminating null wide-character code copied into the ws1 buffer. [Option End]

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

strcpy , wcsdup , wcsncpy

XBD <wchar.h>

CHANGE HISTORY

First released in Issue 4. Derived from the MSE working draft.

Issue 6

The wcscpy() prototype is updated for alignment with the ISO/IEC 9899:1999 standard.

Issue 7

The wcpcpy() function is added from The Open Group Technical Standard, 2006, Extended API Set Part 1.

Issue 8

Austin Group Defect 448 is applied, adding a requirement that wcscpy() and wcpcpy() do not change the setting of errno on valid input.

End of informative text.

 

return to top of page

UNIX® is a registered Trademark of The Open Group.
POSIX™ is a Trademark of The IEEE.
Copyright © 2001-2024 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]