lib/libc/string/wcsdup.3

   1 .\"     $NetBSD: wcsdup.3,v 1.4 2012/12/28 13:53:12 wiz 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 .\"     from: @(#)strdup.3      8.1 (Berkeley) 6/9/93
  31 .\"
  32 .Dd August 25, 2006
  33 .Dt WCSDUP 3
  34 .Os
  35 .Sh NAME
  36 .Nm wcsdup
  37 .Nd save a copy of a wide string
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In wchar.h
  42 .Ft wchar_t *
  43 .Fn wcsdup "const wchar_t *str"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn wcsdup
  47 function
  48 allocates sufficient memory for a copy
  49 of the wide-character string
  50 .Fa str ,
  51 does the copy, and returns a pointer to it.
  52 The pointer may subsequently be used as an
  53 argument to the function
  54 .Xr free 3 .
  55 .Pp
  56 If insufficient memory is available,
  57 .Dv NULL
  58 is returned.
  59 .Sh EXAMPLES
  60 The following will point
  61 .Va p
  62 to an allocated area of memory containing the nul-terminated string
  63 .Qq foobar :
  64 .Bd -literal -offset indent
  65 wchar_t *p;
  66
  67 if (p = wcsdup(L"foobar"), p == NULL) {
  68         fprintf(stderr, "Out of memory.\en");
  69         exit(1);
  70 }
  71 .Ed
  72 .Sh ERRORS
  73 The
  74 .Fn wcsdup
  75 function may fail and set the external variable
  76 .Va errno
  77 for any of the errors specified for the library function
  78 .Xr malloc 3 .
  79 .Sh SEE ALSO
  80 .Xr free 3 ,
  81 .Xr malloc 3 ,
  82 .Xr strdup 3
  83 .Sh HISTORY
  84 The
  85 .Fn wcsdup
  86 function first appeared in
  87 .Nx 4.0 .