lib/libc/locale/mbtowc.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: head/lib/libc/locale/mbtowc.3 165903 2007-01-09 00:28:16Z imp $
  35 .\"
  36 .Dd December 26, 2013
  37 .Dt MBTOWC 3
  38 .Os
  39 .Sh NAME
  40 .Nm mbtowc ,
  41 .Nm mbtowc_l
  42 .Nd convert a character to a wide-character code
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In stdlib.h
  47 .Ft int
  48 .Fo mbtowc
  49 .Fa "wchar_t * restrict wcharp" "const char * restrict mbchar"
  50 .Fa "size_t nbytes"
  51 .Fc
  52 .In xlocale.h
  53 .Ft int
  54 .Fo mbtowc_l
  55 .Fa "wchar_t * restrict wcharp" "const char * restrict mbchar"
  56 .Fa "size_t nbytes" "locale_t locale"
  57 .Fc
  58 .Sh DESCRIPTION
  59 The
  60 .Fn mbtowc
  61 and
  62 .Fn mbtowc_l
  63 functions convert a multibyte character
  64 .Fa mbchar
  65 into a wide character according to the current conversion state,
  66 and stores the result
  67 in the object pointed to by
  68 .Fa wcharp .
  69 Up to
  70 .Fa nbytes
  71 bytes are examined.
  72 .Pp
  73 A call with a null
  74 .Fa mbchar
  75 pointer returns nonzero if the current encoding requires shift states,
  76 zero otherwise;
  77 if shift states are required, the shift state is reset to the initial state.
  78 .Pp
  79 The
  80 .Fn mbtowc_l
  81 function takes an explicit
  82 .Fa locale
  83 argument, whereas the
  84 .Fn mbtowc
  85 function uses the current global or per-thread locale.
  86 .Sh RETURN VALUES
  87 If
  88 .Fa mbchar
  89 is
  90 .Dv NULL ,
  91 the
  92 .Fn mbtowc
  93 and
  94 .Fn mbtowc_l
  95 functions return nonzero if shift states are supported,
  96 zero otherwise.
  97 .Pp
  98 Otherwise, if
  99 .Fa mbchar
 100 is not a null pointer,
 101 .Fn mbtowc
 102 and
 103 .Fn mbtowc_l
 104 either return 0 if
 105 .Fa mbchar
 106 represents the null wide character, or return
 107 the number of bytes processed in
 108 .Fa mbchar ,
 109 or return \-1 if no multibyte character
 110 could be recognized or converted.
 111 In this case,
 112 .Fn mbtowc Ns 's
 113 and
 114 .Fn mbtowc_l Ns 's
 115 internal conversion states are undefined.
 116 .Sh ERRORS
 117 The
 118 .Fn mbtowc
 119 and
 120 .Fn mbtowc_l
 121 functions will fail if:
 122 .Bl -tag -width Er
 123 .It Bq Er EILSEQ
 124 An invalid multibyte sequence was detected.
 125 .It Bq Er EINVAL
 126 The internal conversion state is invalid.
 127 .El
 128 .Sh SEE ALSO
 129 .Xr btowc 3 ,
 130 .Xr mbintowcr 3 ,
 131 .Xr mblen 3 ,
 132 .Xr mbrtowc 3 ,
 133 .Xr mbstowcs 3 ,
 134 .Xr multibyte 3 ,
 135 .Xr utf8towcr 3 ,
 136 .Xr wctomb 3 ,
 137 .Xr xlocale 3
 138 .Sh STANDARDS
 139 The
 140 .Fn mbtowc
 141 function conforms to
 142 .St -isoC-99 .