[apple/libc.git] / locale / FreeBSD / mbstowcs.3

.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
.\" Copyright (c) 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Donn Seeley of BSDI.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" From @(#)multibyte.3	8.1 (Berkeley) 6/4/93
.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
.\" $FreeBSD: src/lib/libc/locale/mbstowcs.3,v 1.5 2007/01/09 00:28:00 imp Exp $
.\"
.Dd April 8, 2004
.Dt MBSTOWCS 3
.Os
.Sh NAME
.Nm mbstowcs
.Nd convert a character string to a wide-character string
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft size_t
.Fo mbstowcs
.Fa "wchar_t * restrict wcstring" "const char * restrict mbstring"
.Fa "size_t nwchars"
.Fc
.Sh DESCRIPTION
The
.Fn mbstowcs
function converts a multibyte character string
.Fa mbstring
beginning in the initial conversion state
into a wide character string
.Fa wcstring .
No more than
.Fa nwchars
wide characters are stored.
A terminating null wide character is appended if there is room.
.Sh RETURN VALUES
The
.Fn mbstowcs
function returns the number of wide characters converted,
not counting any terminating null wide character, or \-1
if an invalid multibyte character was encountered.
.Sh ERRORS
The
.Fn mbstowcs
function will fail if:
.Bl -tag -width Er
.It Bq Er EILSEQ
An invalid multibyte sequence was detected.
.It Bq Er EINVAL
The conversion state is invalid.
.El
.Sh SEE ALSO
.Xr mbsrtowcs 3 ,
.Xr mbtowc 3 ,
.Xr multibyte 3
.Sh STANDARDS
The
.Fn mbstowcs
function conforms to
.St -isoC-99 .
Commit	Line	Data
3d9156a7	1	.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
5b2abdfb	2	.\" Copyright (c) 1993
e9ce8d39 A	3	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	4	.\"
5b2abdfb	5	.\" This code is derived from software contributed to Berkeley by
3d9156a7	6	.\" Donn Seeley of BSDI.
5b2abdfb	7	.\"
e9ce8d39 A	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.
e9ce8d39 A	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	.\"
3d9156a7 A	32	.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
3d9156a7 A	33	.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
1f2f436a	34	.\" $FreeBSD: src/lib/libc/locale/mbstowcs.3,v 1.5 2007/01/09 00:28:00 imp Exp $
e9ce8d39	35	.\"
3d9156a7 A	36	.Dd April 8, 2004
3d9156a7 A	37	.Dt MBSTOWCS 3
e9ce8d39 A	38	.Os
e9ce8d39 A	39	.Sh NAME
3d9156a7 A	40	.Nm mbstowcs
	41	.Nd convert a character string to a wide-character string
	42	.Sh LIBRARY
	43	.Lb libc
e9ce8d39	44	.Sh SYNOPSIS
3d9156a7 A	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
e9ce8d39 A	51	.Sh DESCRIPTION
e9ce8d39 A	52	The
3d9156a7 A	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 .