[thirdparty/man-pages.git] / man3 / wcsdup.3

.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\" %%%LICENSE_END
.\"
.\" References consulted:
.\"   GNU glibc-2 source code and manual
.\"   Dinkumware C library reference http://www.dinkumware.com/
.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
.\"
.TH WCSDUP 3  2017-09-15 "GNU" "Linux Programmer's Manual"
.SH NAME
wcsdup \- duplicate a wide-character string
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.PP
.BI "wchar_t *wcsdup(const wchar_t *" s );
.fi
.PP
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.PP
.BR wcsdup ():
.PD 0
.ad l
.RS 4
.TP 4
Since glibc 2.10:
_POSIX_C_SOURCE\ >=\ 200809L
.TP
Before glibc 2.10:
_GNU_SOURCE
.RE
.ad
.PD
.SH DESCRIPTION
The
.BR wcsdup ()
function is the wide-character equivalent
of the
.BR strdup (3)
function.
It allocates and returns a new wide-character string whose initial
contents is a duplicate of the wide-character string pointed to by
.IR s .
.PP
Memory for the new wide-character string is
obtained with
.BR malloc (3),
and should be freed with
.BR free (3).
.SH RETURN VALUE
On success,
.BR wcsdup ()
returns a pointer to the new wide-character string.
On error, it returns NULL, with
.I errno
set to indicate the cause of the error.
.SH ERRORS
.TP
.B ENOMEM
Insufficient memory available to allocate duplicate string.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lb lb lb
l l l.
Interface	Attribute	Value
T{
.BR wcsdup ()
T}	Thread safety	MT-Safe
.TE
.sp 1
.SH CONFORMING TO
POSIX.1-2008.
This function is not specified in POSIX.1-2001,
and is not widely available on other systems.
.\" present in libc5 and glibc 2.0 and later
.SH SEE ALSO
.BR strdup (3),
.BR wcscpy (3)
Commit	Line	Data
	1	.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
	2	.\"
	3	.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
	4	.\" This is free documentation; you can redistribute it and/or
	5	.\" modify it under the terms of the GNU General Public License as
	6	.\" published by the Free Software Foundation; either version 2 of
	7	.\" the License, or (at your option) any later version.
	8	.\" %%%LICENSE_END
	9	.\"
	10	.\" References consulted:
	11	.\" GNU glibc-2 source code and manual
	12	.\" Dinkumware C library reference http://www.dinkumware.com/
	13	.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
	14	.\"
	15	.TH WCSDUP 3 2017-09-15 "GNU" "Linux Programmer's Manual"
	16	.SH NAME
	17	wcsdup \- duplicate a wide-character string
	18	.SH SYNOPSIS
	19	.nf
	20	.B #include <wchar.h>
	21	.PP
	22	.BI "wchar_t wcsdup(const wchar_t " s );
	23	.fi
	24	.PP
	25	.in -4n
	26	Feature Test Macro Requirements for glibc (see
	27	.BR feature_test_macros (7)):
	28	.in
	29	.PP
	30	.BR wcsdup ():
	31	.PD 0
	32	.ad l
	33	.RS 4
	34	.TP 4
	35	Since glibc 2.10:
	36	_POSIX_C_SOURCE\ >=\ 200809L
	37	.TP
	38	Before glibc 2.10:
	39	_GNU_SOURCE
	40	.RE
	41	.ad
	42	.PD
	43	.SH DESCRIPTION
	44	The
	45	.BR wcsdup ()
	46	function is the wide-character equivalent
	47	of the
	48	.BR strdup (3)
	49	function.
	50	It allocates and returns a new wide-character string whose initial
	51	contents is a duplicate of the wide-character string pointed to by
	52	.IR s .
	53	.PP
	54	Memory for the new wide-character string is
	55	obtained with
	56	.BR malloc (3),
	57	and should be freed with
	58	.BR free (3).
	59	.SH RETURN VALUE
	60	On success,
	61	.BR wcsdup ()
	62	returns a pointer to the new wide-character string.
	63	On error, it returns NULL, with
	64	.I errno
	65	set to indicate the cause of the error.
	66	.SH ERRORS
	67	.TP
	68	.B ENOMEM
	69	Insufficient memory available to allocate duplicate string.
	70	.SH ATTRIBUTES
	71	For an explanation of the terms used in this section, see
	72	.BR attributes (7).
	73	.TS
	74	allbox;
	75	lb lb lb
	76	l l l.
	77	Interface Attribute Value
	78	T{
	79	.BR wcsdup ()
	80	T} Thread safety MT-Safe
	81	.TE
	82	.sp 1
	83	.SH CONFORMING TO
	84	POSIX.1-2008.
	85	This function is not specified in POSIX.1-2001,
	86	and is not widely available on other systems.
	87	.\" present in libc5 and glibc 2.0 and later
	88	.SH SEE ALSO
	89	.BR strdup (3),
	90	.BR wcscpy (3)