lib/libc/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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
  32 .\"
  33 .Dd April 8, 2004
  34 .Dt WCSTOMBS 3
  35 .Os
  36 .Sh NAME
  37 .Nm wcstombs
  38 .Nd convert a wide-character string to a character string
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In stdlib.h
  43 .Ft size_t
  44 .Fo wcstombs
  45 .Fa "char * restrict mbstring" "const wchar_t * restrict wcstring"
  46 .Fa "size_t nbytes"
  47 .Fc
  48 .Sh DESCRIPTION
  49 The
  50 .Fn wcstombs
  51 function converts a wide character string
  52 .Fa wcstring
  53 into a multibyte character string,
  54 .Fa mbstring ,
  55 beginning in the initial conversion state.
  56 Up to
  57 .Fa nbytes
  58 bytes are stored in
  59 .Fa mbstring .
  60 Partial multibyte characters at the end of the string are not stored.
  61 The multibyte character string is null terminated if there is room.
  62 .Sh RETURN VALUES
  63 The
  64 .Fn wcstombs
  65 function returns the number of bytes converted
  66 (not including any terminating null), if successful, otherwise it returns
  67 .Po Vt size_t Pc Ns \-1 .
  68 .Sh ERRORS
  69 The
  70 .Fn wcstombs
  71 function will fail if:
  72 .Bl -tag -width Er
  73 .It Bq Er EILSEQ
  74 An invalid wide character was encountered.
  75 .It Bq Er EINVAL
  76 The conversion state is invalid.
  77 .El
  78 .Sh SEE ALSO
  79 .Xr mbstowcs 3 ,
  80 .Xr multibyte 3 ,
  81 .Xr wcsrtombs 3 ,
  82 .Xr wctomb 3
  83 .Sh STANDARDS
  84 The
  85 .Fn wcstombs
  86 function conforms to
  87 .St -isoC-99 .