locale/wcstombs.3

   1 .\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
   2 .\" Copyright (c) 1993
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" Donn Seeley of BSDI.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\" From @(#)multibyte.3        8.1 (Berkeley) 6/4/93
  37 .\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
  38 .\" $FreeBSD: src/lib/libc/locale/wcstombs.3,v 1.4 2004/07/05 06:36:36 ru Exp $
  39 .\"
  40 .Dd April 8, 2004
  41 .Dt WCSTOMBS 3
  42 .Os
  43 .Sh NAME
  44 .Nm wcstombs ,
  45 .Nm wcstombs_l
  46 .Nd convert a wide-character string to a character string
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdlib.h
  51 .Ft size_t
  52 .Fo wcstombs
  53 .Fa "char *restrict s"
  54 .Fa "const wchar_t *restrict pwcs"
  55 .Fa "size_t n"
  56 .Fc
  57 .In stdlib.h
  58 .In xlocale.h
  59 .Ft size_t
  60 .Fo wcstombs_l
  61 .Fa "char *restrict s"
  62 .Fa "const wchar_t *restrict pwcs"
  63 .Fa "size_t n"
  64 .Fa "locale_t loc"
  65 .Fc
  66 .Sh DESCRIPTION
  67 The
  68 .Fn wcstombs
  69 function converts a wide character string
  70 .Fa pwcs
  71 into a multibyte character string,
  72 .Fa s ,
  73 beginning in the initial conversion state.
  74 Up to
  75 .Fa n
  76 bytes are stored in
  77 .Fa s .
  78 Partial multibyte characters at the end of the string are not stored.
  79 The multibyte character string is null terminated, if there is room.
  80 .Pp
  81 Although the
  82 .Fn wcstombs
  83 function uses the current locale, the
  84 .Fn wcstombs_l
  85 function may be passed a locale directly. See
  86 .Xr xlocale 3
  87 for more information.
  88 .Sh RETURN VALUES
  89 The
  90 .Fn wcstombs
  91 function returns the number of bytes converted
  92 (not including any terminating null), if successful;
  93 otherwise, it returns
  94 .Po Vt size_t Pc Ns \-1 .
  95 .Sh ERRORS
  96 The
  97 .Fn wcstombs
  98 function will fail if:
  99 .Bl -tag -width Er
 100 .It Bq Er EILSEQ
 101 An invalid wide character was encountered.
 102 .It Bq Er EINVAL
 103 The conversion state is invalid.
 104 .El
 105 .Sh SEE ALSO
 106 .Xr mbstowcs 3 ,
 107 .Xr multibyte 3 ,
 108 .Xr wcsrtombs 3 ,
 109 .Xr wctomb 3 ,
 110 .Xr xlocale 3
 111 .Sh STANDARDS
 112 The
 113 .Fn wcstombs
 114 function conforms to
 115 .St -isoC-99 .