1.\" $OpenBSD: strdup.3,v 1.10 2000/04/21 15:32:15 aaron 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. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)strdup.3 8.1 (Berkeley) 6/9/93 35.\" 36.Dd June 9, 1993 37.Dt STRDUP 3 38.Os 39.Sh NAME 40.Nm strdup 41.Nd save a copy of a string 42.Sh SYNOPSIS 43.Fd #include <string.h> 44.Ft char * 45.Fn strdup "const char *s" 46.Sh DESCRIPTION 47The 48.Fn strdup 49function allocates sufficient memory for a copy of the string 50.Fa s , 51does the copy, and returns a pointer to it. 52The pointer may subsequently be used as an argument to the function 53.Xr free 3 . 54.Pp 55If insufficient memory is available, 56.Dv NULL 57is returned. 58.Sh EXAMPLES 59The following will point 60.Va p 61to an allocated area of memory containing the null-terminated string 62.Qq foobar : 63.Bd -literal -offset indent 64char *p; 65 66if ((p = strdup("foobar")) == NULL) { 67 fprintf(stderr, "Out of memory.\en"); 68 exit(1); 69} 70.Ed 71.Sh ERRORS 72The 73.Fn strdup 74function may fail and set the external variable 75.Va errno 76for any of the errors specified for the library function 77.Xr malloc 3 . 78.Sh SEE ALSO 79.Xr free 3 , 80.Xr malloc 3 , 81.Xr strcpy 3 , 82.Xr strlen 3 83.Sh HISTORY 84The 85.Fn strdup 86function first appeared in 87.Bx 4.4 . 88