[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 ,
.Nm mbstowcs_l
.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 pwcs"
.Fa "const char *restrict s"
.Fa "size_t n"
.Fc
.In stdlib.h
.In xlocale.h
.Ft size_t
.Fo mbstowcs_l
.Fa "wchar_t *restrict pwcs"
.Fa "const char *restrict s"
.Fa "size_t n"
.Fa "locale_t loc"
.Fc
.Sh DESCRIPTION
The
.Fn mbstowcs
function converts a multibyte character string
.Fa s ,
beginning in the initial conversion state,
into a wide character string
.Fa pwcs .
No more than
.Fa n
wide characters are stored.
A terminating null wide character is appended, if there is room.
.Pp
Although the
.Fn mbstowcs
function uses the current locale, the
.Fn mbstowcs_l
function may be passed a locale directly. See
.Xr xlocale 3
for more information.
.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 ,
.Xr xlocale 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
ad3c9f2a A	40	.Nm mbstowcs ,
ad3c9f2a A	41	.Nm mbstowcs_l
3d9156a7 A	42	.Nd convert a character string to a wide-character string
	43	.Sh LIBRARY
	44	.Lb libc
e9ce8d39	45	.Sh SYNOPSIS
3d9156a7 A	46	.In stdlib.h
	47	.Ft size_t
	48	.Fo mbstowcs
ad3c9f2a A	49	.Fa "wchar_t *restrict pwcs"
	50	.Fa "const char *restrict s"
	51	.Fa "size_t n"
	52	.Fc
	53	.In stdlib.h
	54	.In xlocale.h
	55	.Ft size_t
	56	.Fo mbstowcs_l
	57	.Fa "wchar_t *restrict pwcs"
	58	.Fa "const char *restrict s"
	59	.Fa "size_t n"
	60	.Fa "locale_t loc"
3d9156a7	61	.Fc
e9ce8d39 A	62	.Sh DESCRIPTION
e9ce8d39 A	63	The
3d9156a7 A	64	.Fn mbstowcs
3d9156a7 A	65	function converts a multibyte character string
ad3c9f2a A	66	.Fa s ,
ad3c9f2a A	67	beginning in the initial conversion state,
3d9156a7	68	into a wide character string
ad3c9f2a	69	.Fa pwcs .
3d9156a7	70	No more than
ad3c9f2a	71	.Fa n
3d9156a7	72	wide characters are stored.
ad3c9f2a A	73	A terminating null wide character is appended, if there is room.
	74	.Pp
	75	Although the
	76	.Fn mbstowcs
	77	function uses the current locale, the
	78	.Fn mbstowcs_l
	79	function may be passed a locale directly. See
	80	.Xr xlocale 3
	81	for more information.
3d9156a7 A	82	.Sh RETURN VALUES
	83	The
	84	.Fn mbstowcs
	85	function returns the number of wide characters converted,
	86	not counting any terminating null wide character, or \-1
	87	if an invalid multibyte character was encountered.
	88	.Sh ERRORS
	89	The
	90	.Fn mbstowcs
	91	function will fail if:
	92	.Bl -tag -width Er
	93	.It Bq Er EILSEQ
	94	An invalid multibyte sequence was detected.
	95	.It Bq Er EINVAL
	96	The conversion state is invalid.
	97	.El
	98	.Sh SEE ALSO
	99	.Xr mbsrtowcs 3 ,
	100	.Xr mbtowc 3 ,
ad3c9f2a A	101	.Xr multibyte 3 ,
ad3c9f2a A	102	.Xr xlocale 3
3d9156a7 A	103	.Sh STANDARDS
	104	The
	105	.Fn mbstowcs
	106	function conforms to
	107	.St -isoC-99 .