locale/wctomb.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/wctomb.3,v 1.3 2004/07/05 06:36:36 ru Exp $
  39 .\"
  40 .Dd April 8, 2004
  41 .Dt WCTOMB 3
  42 .Os
  43 .Sh NAME
  44 .Nm wctomb ,
  45 .Nm wctomb_l
  46 .Nd convert a wide-character code to a character
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdlib.h
  51 .Ft int
  52 .Fo wctomb
  53 .Fa "char *s"
  54 .Fa "wchar_t wchar"
  55 .Fc
  56 .In stdlib.h
  57 .In xlocale.h
  58 .Ft int
  59 .Fo wctomb_l
  60 .Fa "char *s"
  61 .Fa "wchar_t wchar"
  62 .Fa "locale_t loc"
  63 .Fc
  64 .Sh DESCRIPTION
  65 The
  66 .Fn wctomb
  67 function converts a wide character,
  68 .Fa wchar ,
  69 into a multibyte character and stores the result in
  70 .Fa s .
  71 The object pointed to by
  72 .Fa s
  73 must be large enough to accommodate the multibyte character,
  74 which may be up to
  75 .Dv MB_LEN_MAX
  76 bytes.
  77 .Pp
  78 A call with a null
  79 .Fa s
  80 pointer returns nonzero if the current locale requires shift states,
  81 zero otherwise;
  82 if shift states are required, the shift state is reset to the initial state.
  83 .Pp
  84 Although the
  85 .Fn wctomb
  86 function uses the current locale, the
  87 .Fn wctomb_l
  88 function may be passed a locale directly. See
  89 .Xr xlocale 3
  90 for more information.
  91 .Sh RETURN VALUES
  92 If
  93 .Fa s
  94 is
  95 .Dv NULL ,
  96 the
  97 .Fn wctomb
  98 function returns nonzero if shift states are supported,
  99 zero otherwise.
 100 If
 101 .Fa s
 102 is valid,
 103 .Fn wctomb
 104 returns
 105 the number of bytes processed in
 106 .Fa s ,
 107 or \-1 if no multibyte character
 108 could be recognized or converted.
 109 In this case,
 110 .Fn wctomb Ns 's
 111 internal conversion state is undefined.
 112 .Sh ERRORS
 113 The
 114 .Fn wctomb
 115 function will fail if:
 116 .Bl -tag -width Er
 117 .It Bq Er EILSEQ
 118 An invalid multibyte sequence was detected.
 119 .It Bq Er EINVAL
 120 The internal conversion state is invalid.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr mbtowc 3 ,
 124 .Xr wcrtomb 3 ,
 125 .Xr wcstombs 3 ,
 126 .Xr wctob 3 ,
 127 .Xr xlocale 3
 128 .Sh STANDARDS
 129 The
 130 .Fn wctomb
 131 function conforms to
 132 .St -isoC-99 .