diff options
Diffstat (limited to 'src/lib/libc/string/strdup.3')
| -rw-r--r-- | src/lib/libc/string/strdup.3 | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/src/lib/libc/string/strdup.3 b/src/lib/libc/string/strdup.3 new file mode 100644 index 0000000000..45a7bd1826 --- /dev/null +++ b/src/lib/libc/string/strdup.3 | |||
| @@ -0,0 +1,112 @@ | |||
| 1 | .\" $OpenBSD: strdup.3,v 1.19 2011/12/08 08:06:19 lum Exp $ | ||
| 2 | .\" | ||
| 3 | .\" Copyright (c) 1990, 1991, 1993 | ||
| 4 | .\" The Regents of the University of California. All rights reserved. | ||
| 5 | .\" | ||
| 6 | .\" Redistribution and use in source and binary forms, with or without | ||
| 7 | .\" modification, are permitted provided that the following conditions | ||
| 8 | .\" are met: | ||
| 9 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 10 | .\" notice, this list of conditions and the following disclaimer. | ||
| 11 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer in the | ||
| 13 | .\" documentation and/or other materials provided with the distribution. | ||
| 14 | .\" 3. Neither the name of the University nor the names of its contributors | ||
| 15 | .\" may be used to endorse or promote products derived from this software | ||
| 16 | .\" without specific prior written permission. | ||
| 17 | .\" | ||
| 18 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
| 19 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 20 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| 21 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
| 22 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| 23 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| 24 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 25 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| 26 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| 27 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| 28 | .\" SUCH DAMAGE. | ||
| 29 | .\" | ||
| 30 | .\" @(#)strdup.3 8.1 (Berkeley) 6/9/93 | ||
| 31 | .\" | ||
| 32 | .Dd $Mdocdate: December 8 2011 $ | ||
| 33 | .Dt STRDUP 3 | ||
| 34 | .Os | ||
| 35 | .Sh NAME | ||
| 36 | .Nm strdup , | ||
| 37 | .Nm strndup | ||
| 38 | .Nd save a copy of a string | ||
| 39 | .Sh SYNOPSIS | ||
| 40 | .Fd #include <string.h> | ||
| 41 | .Ft char * | ||
| 42 | .Fn strdup "const char *s" | ||
| 43 | .Ft char * | ||
| 44 | .Fn strndup "const char *s" "size_t maxlen" | ||
| 45 | .Sh DESCRIPTION | ||
| 46 | The | ||
| 47 | .Fn strdup | ||
| 48 | function allocates sufficient memory for a copy of the string | ||
| 49 | .Fa s , | ||
| 50 | does the copy, and returns a pointer to it. | ||
| 51 | The pointer may subsequently be used as an argument to the function | ||
| 52 | .Xr free 3 . | ||
| 53 | .Pp | ||
| 54 | The | ||
| 55 | .Fn strndup | ||
| 56 | function behaves similarly to | ||
| 57 | .Nm strdup | ||
| 58 | but only copies up to | ||
| 59 | .Fa maxlen | ||
| 60 | characters from | ||
| 61 | .Fa s . | ||
| 62 | The resulting string is always NUL-terminated. | ||
| 63 | .Pp | ||
| 64 | If insufficient memory is available, | ||
| 65 | .Dv NULL | ||
| 66 | is returned. | ||
| 67 | .Sh EXAMPLES | ||
| 68 | The following will point | ||
| 69 | .Va p | ||
| 70 | to an allocated area of memory containing the NUL-terminated string | ||
| 71 | .Qq foobar : | ||
| 72 | .Bd -literal -offset indent | ||
| 73 | char *p; | ||
| 74 | |||
| 75 | p = strdup("foobar"); | ||
| 76 | if (p == NULL) | ||
| 77 | err(1, NULL); | ||
| 78 | .Ed | ||
| 79 | .Sh ERRORS | ||
| 80 | The | ||
| 81 | .Fn strdup | ||
| 82 | and | ||
| 83 | .Fn strndup | ||
| 84 | functions may fail and set the external variable | ||
| 85 | .Va errno | ||
| 86 | for any of the errors specified for the library function | ||
| 87 | .Xr malloc 3 . | ||
| 88 | .Sh SEE ALSO | ||
| 89 | .Xr free 3 , | ||
| 90 | .Xr malloc 3 , | ||
| 91 | .Xr strcpy 3 , | ||
| 92 | .Xr strlcpy 3 , | ||
| 93 | .Xr strlen 3 , | ||
| 94 | .Xr wcsdup 3 | ||
| 95 | .Sh STANDARDS | ||
| 96 | The | ||
| 97 | .Fn strdup | ||
| 98 | and | ||
| 99 | .Fn strndup | ||
| 100 | functions conform to | ||
| 101 | .St -p1003.1-2008 . | ||
| 102 | .Sh HISTORY | ||
| 103 | The | ||
| 104 | .Fn strdup | ||
| 105 | function first appeared in | ||
| 106 | .Bx 4.3 Reno . | ||
| 107 | The | ||
| 108 | .Fn strndup | ||
| 109 | function appeared in glibc 2.0, was reimplemented for | ||
| 110 | .Nx 4.0 , | ||
| 111 | and ported to | ||
| 112 | .Ox 4.8 . | ||
