[apple/libc.git] / locale / FreeBSD / wcstombs.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/wcstombs.3,v 1.5 2007/01/09 00:28:01 imp Exp $
.\"
.Dd April 8, 2004
.Dt WCSTOMBS 3
.Os
.Sh NAME
.Nm wcstombs ,
.Nm wcstombs_l
.Nd convert a wide-character string to a character string
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft size_t
.Fo wcstombs
.Fa "char *restrict s"
.Fa "const wchar_t *restrict pwcs"
.Fa "size_t n"
.Fc
.In stdlib.h
.In xlocale.h
.Ft size_t
.Fo wcstombs_l
.Fa "char *restrict s"
.Fa "const wchar_t *restrict pwcs"
.Fa "size_t n"
.Fa "locale_t loc"
.Fc
.Sh DESCRIPTION
The
.Fn wcstombs
function converts a wide character string
.Fa pwcs
into a multibyte character string,
.Fa s ,
beginning in the initial conversion state.
Up to
.Fa n
bytes are stored in
.Fa s .
Partial multibyte characters at the end of the string are not stored.
The multibyte character string is null terminated, if there is room.
.Pp
Although the
.Fn wcstombs
function uses the current locale, the
.Fn wcstombs_l
function may be passed a locale directly. See
.Xr xlocale 3
for more information.
.Sh RETURN VALUES
The
.Fn wcstombs
function returns the number of bytes converted
(not including any terminating null), if successful;
otherwise, it returns
.Po Vt size_t Pc Ns \-1 .
.Sh ERRORS
The
.Fn wcstombs
function will fail if:
.Bl -tag -width Er
.It Bq Er EILSEQ
An invalid wide character was encountered.
.It Bq Er EINVAL
The conversion state is invalid.
.El
.Sh SEE ALSO
.Xr mbstowcs 3 ,
.Xr multibyte 3 ,
.Xr wcsrtombs 3 ,
.Xr wctomb 3 ,
.Xr xlocale 3
.Sh STANDARDS
The
.Fn wcstombs
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/wcstombs.3,v 1.5 2007/01/09 00:28:01 imp Exp $
e9ce8d39	35	.\"
3d9156a7 A	36	.Dd April 8, 2004
3d9156a7 A	37	.Dt WCSTOMBS 3
e9ce8d39 A	38	.Os
e9ce8d39 A	39	.Sh NAME
ad3c9f2a A	40	.Nm wcstombs ,
ad3c9f2a A	41	.Nm wcstombs_l
3d9156a7 A	42	.Nd convert a wide-character string to a character string
	43	.Sh LIBRARY
	44	.Lb libc
e9ce8d39	45	.Sh SYNOPSIS
3d9156a7 A	46	.In stdlib.h
	47	.Ft size_t
	48	.Fo wcstombs
ad3c9f2a A	49	.Fa "char *restrict s"
	50	.Fa "const wchar_t *restrict pwcs"
	51	.Fa "size_t n"
	52	.Fc
	53	.In stdlib.h
	54	.In xlocale.h
	55	.Ft size_t
	56	.Fo wcstombs_l
	57	.Fa "char *restrict s"
	58	.Fa "const wchar_t *restrict pwcs"
	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 wcstombs
3d9156a7 A	65	function converts a wide character string
ad3c9f2a	66	.Fa pwcs
3d9156a7	67	into a multibyte character string,
ad3c9f2a	68	.Fa s ,
3d9156a7 A	69	beginning in the initial conversion state.
3d9156a7 A	70	Up to
ad3c9f2a	71	.Fa n
3d9156a7	72	bytes are stored in
ad3c9f2a	73	.Fa s .
3d9156a7	74	Partial multibyte characters at the end of the string are not stored.
ad3c9f2a A	75	The multibyte character string is null terminated, if there is room.
	76	.Pp
	77	Although the
	78	.Fn wcstombs
	79	function uses the current locale, the
	80	.Fn wcstombs_l
	81	function may be passed a locale directly. See
	82	.Xr xlocale 3
	83	for more information.
3d9156a7 A	84	.Sh RETURN VALUES
	85	The
	86	.Fn wcstombs
	87	function returns the number of bytes converted
ad3c9f2a A	88	(not including any terminating null), if successful;
ad3c9f2a A	89	otherwise, it returns
3d9156a7 A	90	.Po Vt size_t Pc Ns \-1 .
	91	.Sh ERRORS
	92	The
	93	.Fn wcstombs
	94	function will fail if:
	95	.Bl -tag -width Er
	96	.It Bq Er EILSEQ
	97	An invalid wide character was encountered.
	98	.It Bq Er EINVAL
	99	The conversion state is invalid.
	100	.El
	101	.Sh SEE ALSO
	102	.Xr mbstowcs 3 ,
	103	.Xr multibyte 3 ,
	104	.Xr wcsrtombs 3 ,
ad3c9f2a A	105	.Xr wctomb 3 ,
ad3c9f2a A	106	.Xr xlocale 3
3d9156a7 A	107	.Sh STANDARDS
	108	The
	109	.Fn wcstombs
	110	function conforms to
	111	.St -isoC-99 .