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