1 .\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
3 .\" The Regents of the University of California. All rights reserved.
5 .\" This code is derived from software contributed to Berkeley by
6 .\" Donn Seeley of BSDI.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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.
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
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 $
42 .Nd convert a character to a wide-character code
49 .Fa "wchar_t * restrict wcharp" "const char * restrict mbchar"
55 .Fa "wchar_t * restrict wcharp" "const char * restrict mbchar"
56 .Fa "size_t nbytes" "locale_t locale"
63 functions convert a multibyte character
65 into a wide character according to the current conversion state,
67 in the object pointed to by
75 pointer returns nonzero if the current encoding requires shift states,
77 if shift states are required, the shift state is reset to the initial state.
81 function takes an explicit
85 function uses the current global or per-thread locale.
95 functions return nonzero if shift states are supported,
100 is not a null pointer,
106 represents the null wide character, or return
107 the number of bytes processed in
109 or return \-1 if no multibyte character
110 could be recognized or converted.
115 internal conversion states are undefined.
121 functions will fail if:
124 An invalid multibyte sequence was detected.
126 The internal conversion state is invalid.