1.\" $OpenBSD: strdup.3,v 1.12 2003/06/02 20:18:38 millert 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 June 9, 1993 33.Dt STRDUP 3 34.Os 35.Sh NAME 36.Nm strdup 37.Nd save a copy of a string 38.Sh SYNOPSIS 39.Fd #include <string.h> 40.Ft char * 41.Fn strdup "const char *s" 42.Sh DESCRIPTION 43The 44.Fn strdup 45function allocates sufficient memory for a copy of the string 46.Fa s , 47does the copy, and returns a pointer to it. 48The pointer may subsequently be used as an argument to the function 49.Xr free 3 . 50.Pp 51If insufficient memory is available, 52.Dv NULL 53is returned. 54.Sh EXAMPLES 55The following will point 56.Va p 57to an allocated area of memory containing the null-terminated string 58.Qq foobar : 59.Bd -literal -offset indent 60char *p; 61 62if ((p = strdup("foobar")) == NULL) { 63 fprintf(stderr, "Out of memory.\en"); 64 exit(1); 65} 66.Ed 67.Sh ERRORS 68The 69.Fn strdup 70function may fail and set the external variable 71.Va errno 72for any of the errors specified for the library function 73.Xr malloc 3 . 74.Sh SEE ALSO 75.Xr free 3 , 76.Xr malloc 3 , 77.Xr strcpy 3 , 78.Xr strlcpy 3 , 79.Xr strlen 3 80.Sh HISTORY 81The 82.Fn strdup 83function first appeared in 84.Bx 4.4 . 85