]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/wcsdup.3
s/can/should/ for use of free(3)
[thirdparty/man-pages.git] / man3 / wcsdup.3
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" This is free documentation; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 2 of
6 .\" the License, or (at your option) any later version.
7 .\"
8 .\" References consulted:
9 .\" GNU glibc-2 source code and manual
10 .\" Dinkumware C library reference http://www.dinkumware.com/
11 .\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
12 .\"
13 .TH WCSDUP 3 2003-11-01 "GNU" "Linux Programmer's Manual"
14 .SH NAME
15 wcsdup \- duplicate a wide-character string
16 .SH SYNOPSIS
17 .nf
18 .B #define _GNU_SOURCE
19 .br
20 .B #include <wchar.h>
21 .sp
22 .BI "wchar_t *wcsdup(const wchar_t *" s );
23 .fi
24 .SH DESCRIPTION
25 The
26 .BR wcsdup ()
27 function is the wide-character equivalent
28 of the
29 .BR strdup (3)
30 function.
31 It allocates and returns a new wide-character string whose initial
32 contents is a duplicate of the wide-character string pointed to by \fIs\fP.
33 .PP
34 Memory for the new wide-character string is
35 obtained with
36 .BR malloc (3),
37 and should be freed with
38 .BR free (3).
39 .SH "RETURN VALUE"
40 The
41 .BR wcsdup ()
42 function returns a pointer
43 to the new wide-character string,
44 or NULL if sufficient memory was not available.
45 .SH ERRORS
46 .TP
47 .B ENOMEM
48 Insufficient memory available to allocate duplicate string.
49 .SH "CONFORMING TO"
50 This function is a GNU extension.
51 .\" present in libc5 and glibc 2.0 and later
52 .SH "SEE ALSO"
53 .BR strdup (3),
54 .BR wcscpy (3),
55 .BR feature_test_macros (7)