lib/libc/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. 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 WCTOMB 3
  35 .Os
  36 .Sh NAME
  37 .Nm wctomb
  38 .Nd convert a wide-character code to a character
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In stdlib.h
  43 .Ft int
  44 .Fn wctomb "char *mbchar" "wchar_t wchar"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn wctomb
  48 function converts a wide character
  49 .Fa wchar
  50 into a multibyte character and stores
  51 the result in
  52 .Fa mbchar .
  53 The object pointed to by
  54 .Fa mbchar
  55 must be large enough to accommodate the multibyte character, which
  56 may be up to
  57 .Dv MB_LEN_MAX
  58 bytes.
  59 .Pp
  60 A call with a null
  61 .Fa mbchar
  62 pointer returns nonzero if the current locale requires shift states,
  63 zero otherwise;
  64 if shift states are required, the shift state is reset to the initial state.
  65 .Sh RETURN VALUES
  66 If
  67 .Fa mbchar
  68 is
  69 .Dv NULL ,
  70 the
  71 .Fn wctomb
  72 function returns nonzero if shift states are supported,
  73 zero otherwise.
  74 If
  75 .Fa mbchar
  76 is valid,
  77 .Fn wctomb
  78 returns
  79 the number of bytes processed in
  80 .Fa mbchar ,
  81 or \-1 if no multibyte character
  82 could be recognized or converted.
  83 In this case,
  84 .Fn wctomb Ns 's
  85 internal conversion state is undefined.
  86 .Sh ERRORS
  87 The
  88 .Fn wctomb
  89 function will fail if:
  90 .Bl -tag -width Er
  91 .It Bq Er EILSEQ
  92 An invalid multibyte sequence was detected.
  93 .It Bq Er EINVAL
  94 The internal conversion state is invalid.
  95 .El
  96 .Sh SEE ALSO
  97 .Xr mbtowc 3 ,
  98 .Xr wcrtomb 3 ,
  99 .Xr wcstombs 3 ,
 100 .Xr wctob 3
 101 .Sh STANDARDS
 102 The
 103 .Fn wctomb
 104 function conforms to
 105 .St -isoC-99 .