locale/FreeBSD/wcrtomb.3

   1 .\" Copyright (c) 2002-2004 Tim J. Robbins
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc/locale/wcrtomb.3,v 1.4 2004/04/08 09:59:02 tjr Exp $
  26 .\"
  27 .Dd April 8, 2004
  28 .Dt WCRTOMB 3
  29 .Os
  30 .Sh NAME
  31 .Nm wcrtomb
  32 .Nd "convert a wide-character code to a character (restartable)"
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In wchar.h
  37 .Ft size_t
  38 .Fn wcrtomb "char * restrict s" "wchar_t wc" "mbstate_t * restrict ps"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn wcrtomb
  42 function stores a multibyte sequence representing the
  43 wide character
  44 .Fa wc ,
  45 including any necessary shift sequences, to the
  46 character array
  47 .Fa s ,
  48 storing a maximum of
  49 .Dv MB_CUR_MAX
  50 bytes.
  51 .Pp
  52 If
  53 .Fa s
  54 is
  55 .Dv NULL ,
  56 .Fn wcrtomb
  57 behaves as if
  58 .Fa s
  59 pointed to an internal buffer and
  60 .Fa wc
  61 was a null wide character (L'\e0').
  62 .Pp
  63 The
  64 .Ft mbstate_t
  65 argument,
  66 .Fa ps ,
  67 is used to keep track of the shift state.
  68 If it is
  69 .Dv NULL ,
  70 .Fn wcrtomb
  71 uses an internal, static
  72 .Vt mbstate_t
  73 object, which is initialized to the initial conversion state
  74 at program startup.
  75 .Sh RETURN VALUES
  76 The
  77 .Fn wcrtomb
  78 functions returns the length (in bytes) of the multibyte sequence
  79 needed to represent
  80 .Fa wc ,
  81 or
  82 .Po Vt size_t Pc Ns \-1
  83 if
  84 .Fa wc
  85 is not a valid wide character code.
  86 .Sh ERRORS
  87 The
  88 .Fn wcrtomb
  89 function will fail if:
  90 .Bl -tag -width Er
  91 .It Bq Er EILSEQ
  92 An invalid wide character code was specified.
  93 .It Bq Er EINVAL
  94 The conversion state is invalid.
  95 .El
  96 .Sh SEE ALSO
  97 .Xr mbrtowc 3 ,
  98 .Xr multibyte 3 ,
  99 .Xr setlocale 3 ,
 100 .Xr wctomb 3
 101 .Sh STANDARDS
 102 The
 103 .Fn wcrtomb
 104 function conforms to
 105 .St -isoC-99 .