Libc-763.13.tar.gz
[apple/libc.git] / locale / FreeBSD / mbstowcs.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/mbstowcs.3,v 1.5 2007/01/09 00:28:00 imp Exp $
35 .\"
36 .Dd April 8, 2004
37 .Dt MBSTOWCS 3
38 .Os
39 .Sh NAME
40 .Nm mbstowcs
41 .Nd convert a character string to a wide-character string
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In stdlib.h
46 .Ft size_t
47 .Fo mbstowcs
48 .Fa "wchar_t * restrict wcstring" "const char * restrict mbstring"
49 .Fa "size_t nwchars"
50 .Fc
51 .Sh DESCRIPTION
52 The
53 .Fn mbstowcs
54 function converts a multibyte character string
55 .Fa mbstring
56 beginning in the initial conversion state
57 into a wide character string
58 .Fa wcstring .
59 No more than
60 .Fa nwchars
61 wide characters are stored.
62 A terminating null wide character is appended if there is room.
63 .Sh RETURN VALUES
64 The
65 .Fn mbstowcs
66 function returns the number of wide characters converted,
67 not counting any terminating null wide character, or \-1
68 if an invalid multibyte character was encountered.
69 .Sh ERRORS
70 The
71 .Fn mbstowcs
72 function will fail if:
73 .Bl -tag -width Er
74 .It Bq Er EILSEQ
75 An invalid multibyte sequence was detected.
76 .It Bq Er EINVAL
77 The conversion state is invalid.
78 .El
79 .Sh SEE ALSO
80 .Xr mbsrtowcs 3 ,
81 .Xr mbtowc 3 ,
82 .Xr multibyte 3
83 .Sh STANDARDS
84 The
85 .Fn mbstowcs
86 function conforms to
87 .St -isoC-99 .