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