locale/FreeBSD/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 .Nd convert a wide-character string to a character string
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdlib.h
  50 .Ft size_t
  51 .Fo wcstombs
  52 .Fa "char * restrict mbstring" "const wchar_t * restrict wcstring"
  53 .Fa "size_t nbytes"
  54 .Fc
  55 .Sh DESCRIPTION
  56 The
  57 .Fn wcstombs
  58 function converts a wide character string
  59 .Fa wcstring
  60 into a multibyte character string,
  61 .Fa mbstring ,
  62 beginning in the initial conversion state.
  63 Up to
  64 .Fa nbytes
  65 bytes are stored in
  66 .Fa mbstring .
  67 Partial multibyte characters at the end of the string are not stored.
  68 The multibyte character string is null terminated if there is room.
  69 .Sh RETURN VALUES
  70 The
  71 .Fn wcstombs
  72 function returns the number of bytes converted
  73 (not including any terminating null), if successful, otherwise it returns
  74 .Po Vt size_t Pc Ns \-1 .
  75 .Sh ERRORS
  76 The
  77 .Fn wcstombs
  78 function will fail if:
  79 .Bl -tag -width Er
  80 .It Bq Er EILSEQ
  81 An invalid wide character was encountered.
  82 .It Bq Er EINVAL
  83 The conversion state is invalid.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr mbstowcs 3 ,
  87 .Xr multibyte 3 ,
  88 .Xr wcsrtombs 3 ,
  89 .Xr wctomb 3
  90 .Sh STANDARDS
  91 The
  92 .Fn wcstombs
  93 function conforms to
  94 .St -isoC-99 .