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. All advertising materials mentioning features or use of this software 17.\" must display the following acknowledgement: 18.\" This product includes software developed by the University of 19.\" California, Berkeley and its contributors. 20.\" 4. Neither the name of the University nor the names of its contributors 21.\" may be used to endorse or promote products derived from this software 22.\" without specific prior written permission. 23.\" 24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34.\" SUCH DAMAGE. 35.\" 36.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93 37.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp 38.\" $FreeBSD$ 39.\" 40.Dd April 8, 2004 41.Dt MBSTOWCS 3 42.Os 43.Sh NAME 44.Nm mbstowcs 45.Nd convert a character string to a wide-character string 46.Sh LIBRARY 47.Lb libc 48.Sh SYNOPSIS 49.In stdlib.h 50.Ft size_t 51.Fo mbstowcs 52.Fa "wchar_t * restrict wcstring" "const char * restrict mbstring" 53.Fa "size_t nwchars" 54.Fc 55.Sh DESCRIPTION 56The 57.Fn mbstowcs 58function converts a multibyte character string 59.Fa mbstring 60beginning in the initial conversion state 61into a wide character string 62.Fa wcstring . 63No more than 64.Fa nwchars 65wide characters are stored. 66A terminating null wide character is appended if there is room. 67.Sh RETURN VALUES 68The 69.Fn mbstowcs 70function returns the number of wide characters converted, 71not counting any terminating null wide character, or \-1 72if an invalid multibyte character was encountered. 73.Sh ERRORS 74The 75.Fn mbstowcs 76function will fail if: 77.Bl -tag -width Er 78.It Bq Er EILSEQ 79An invalid multibyte sequence was detected. 80.It Bq Er EINVAL 81The conversion state is invalid. 82.El 83.Sh SEE ALSO 84.Xr mbsrtowcs 3 , 85.Xr mbtowc 3 , 86.Xr multibyte 3 87.Sh STANDARDS 88The 89.Fn mbstowcs 90function conforms to 91.St -isoC-99 . 92