[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
.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 mbstring" "const wchar_t * restrict wcstring"
.Fa "size_t nbytes"
.Fc
.Sh DESCRIPTION
The
.Fn wcstombs
function converts a wide character string
.Fa wcstring
into a multibyte character string,
.Fa mbstring ,
beginning in the initial conversion state.
Up to
.Fa nbytes
bytes are stored in
.Fa mbstring .
Partial multibyte characters at the end of the string are not stored.
The multibyte character string is null terminated if there is room.
.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
.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
3d9156a7 A	40	.Nm wcstombs
	41	.Nd convert a wide-character string to a character string
	42	.Sh LIBRARY
	43	.Lb libc
e9ce8d39	44	.Sh SYNOPSIS
3d9156a7 A	45	.In stdlib.h
	46	.Ft size_t
	47	.Fo wcstombs
	48	.Fa "char * restrict mbstring" "const wchar_t * restrict wcstring"
	49	.Fa "size_t nbytes"
	50	.Fc
e9ce8d39 A	51	.Sh DESCRIPTION
e9ce8d39 A	52	The
3d9156a7 A	53	.Fn wcstombs
	54	function converts a wide character string
	55	.Fa wcstring
	56	into a multibyte character string,
	57	.Fa mbstring ,
	58	beginning in the initial conversion state.
	59	Up to
	60	.Fa nbytes
	61	bytes are stored in
	62	.Fa mbstring .
	63	Partial multibyte characters at the end of the string are not stored.
	64	The multibyte character string is null terminated if there is room.
	65	.Sh RETURN VALUES
	66	The
	67	.Fn wcstombs
	68	function returns the number of bytes converted
	69	(not including any terminating null), if successful, otherwise it returns
	70	.Po Vt size_t Pc Ns \-1 .
	71	.Sh ERRORS
	72	The
	73	.Fn wcstombs
	74	function will fail if:
	75	.Bl -tag -width Er
	76	.It Bq Er EILSEQ
	77	An invalid wide character was encountered.
	78	.It Bq Er EINVAL
	79	The conversion state is invalid.
	80	.El
	81	.Sh SEE ALSO
	82	.Xr mbstowcs 3 ,
	83	.Xr multibyte 3 ,
	84	.Xr wcsrtombs 3 ,
	85	.Xr wctomb 3
	86	.Sh STANDARDS
	87	The
	88	.Fn wcstombs
	89	function conforms to
	90	.St -isoC-99 .