|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH WCSDUP "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
wcsdup
|
|
Packit |
7cfc04 |
\(em duplicate a wide-character string
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <wchar.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
wchar_t *wcsdup(const wchar_t *\fIstring\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIwcsdup\fR()
|
|
Packit |
7cfc04 |
function is the wide-character equivalent of the
|
|
Packit |
7cfc04 |
\fIstrdup\fR()
|
|
Packit |
7cfc04 |
function.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIwcsdup\fR()
|
|
Packit |
7cfc04 |
function shall return a pointer to a new wide-character string,
|
|
Packit |
7cfc04 |
allocated as if by a call to
|
|
Packit |
7cfc04 |
\fImalloc\fR(),
|
|
Packit |
7cfc04 |
which is the duplicate of the wide-character string
|
|
Packit |
7cfc04 |
.IR string .
|
|
Packit |
7cfc04 |
The returned pointer can be passed to
|
|
Packit |
7cfc04 |
\fIfree\fR().
|
|
Packit |
7cfc04 |
A null pointer is returned if the new wide-character string cannot be
|
|
Packit |
7cfc04 |
created.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
Upon successful completion, the
|
|
Packit |
7cfc04 |
\fIwcsdup\fR()
|
|
Packit |
7cfc04 |
function shall return a pointer to the newly allocated wide-character
|
|
Packit |
7cfc04 |
string. Otherwise, it shall return a null pointer and set
|
|
Packit |
7cfc04 |
.IR errno
|
|
Packit |
7cfc04 |
to indicate the error.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIwcsdup\fR()
|
|
Packit |
7cfc04 |
function shall fail if:
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR ENOMEM
|
|
Packit |
7cfc04 |
Memory large enough for the duplicate string could not be allocated.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
For functions that allocate memory as if by
|
|
Packit |
7cfc04 |
\fImalloc\fR(),
|
|
Packit |
7cfc04 |
the application should release such memory when it is no longer
|
|
Packit |
7cfc04 |
required by a call to
|
|
Packit |
7cfc04 |
\fIfree\fR().
|
|
Packit |
7cfc04 |
For
|
|
Packit |
7cfc04 |
\fIwcsdup\fR(),
|
|
Packit |
7cfc04 |
this is the return value.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fIfree\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIstrdup\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIwcscpy\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fB<wchar.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|