wcsdup - Man Page

duplicate a wide-character string

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 *wcsdup(const wchar_t *string);

Description

The wcsdup() function is the wide-character equivalent of the strdup() function.

The wcsdup() function shall return a pointer to a new wide-character string, allocated as if by a call to malloc(), which is the duplicate of the wide-character string string. The returned pointer can be passed to free(). A null pointer is returned if the new wide-character string cannot be created.

Return Value

Upon successful completion, the wcsdup() function shall return a pointer to the newly allocated wide-character string. Otherwise, it shall return a null pointer and set errno to indicate the error.

Errors

The wcsdup() function shall fail if:

ENOMEM

Memory large enough for the duplicate string could not be allocated.

The following sections are informative.

Examples

None.

Application Usage

For functions that allocate memory as if by malloc(), the application should release such memory when it is no longer required by a call to free(). For wcsdup(), this is the return value.

Rationale

None.

Future Directions

None.

See Also

free(), strdup(), wcscpy()

The Base Definitions volume of POSIX.1-2017, <wchar.h>

Referenced By

strdup(3p), wchar.h(0p), wcscpy(3p).

2017 IEEE/The Open Group POSIX Programmer's Manual